UNPKG

95.3 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 50 alarms in one operation. In the event of an error, no alarms are deleted.
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 50 alarms in one operation. In the event of an error, no alarms are deleted.
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 * 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 all alarms are returned. CloudWatch retains the history of an alarm even if you delete the alarm.
41 */
42 describeAlarmHistory(params: CloudWatch.Types.DescribeAlarmHistoryInput, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmHistoryOutput) => void): Request<CloudWatch.Types.DescribeAlarmHistoryOutput, AWSError>;
43 /**
44 * 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 all alarms are returned. CloudWatch retains the history of an alarm even if you delete the alarm.
45 */
46 describeAlarmHistory(callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmHistoryOutput) => void): Request<CloudWatch.Types.DescribeAlarmHistoryOutput, AWSError>;
47 /**
48 * Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
49 */
50 describeAlarms(params: CloudWatch.Types.DescribeAlarmsInput, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request<CloudWatch.Types.DescribeAlarmsOutput, AWSError>;
51 /**
52 * Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
53 */
54 describeAlarms(callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request<CloudWatch.Types.DescribeAlarmsOutput, AWSError>;
55 /**
56 * Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
57 */
58 describeAlarmsForMetric(params: CloudWatch.Types.DescribeAlarmsForMetricInput, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsForMetricOutput) => void): Request<CloudWatch.Types.DescribeAlarmsForMetricOutput, AWSError>;
59 /**
60 * Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
61 */
62 describeAlarmsForMetric(callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsForMetricOutput) => void): Request<CloudWatch.Types.DescribeAlarmsForMetricOutput, AWSError>;
63 /**
64 * 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.
65 */
66 describeAnomalyDetectors(params: CloudWatch.Types.DescribeAnomalyDetectorsInput, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAnomalyDetectorsOutput) => void): Request<CloudWatch.Types.DescribeAnomalyDetectorsOutput, AWSError>;
67 /**
68 * 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.
69 */
70 describeAnomalyDetectors(callback?: (err: AWSError, data: CloudWatch.Types.DescribeAnomalyDetectorsOutput) => void): Request<CloudWatch.Types.DescribeAnomalyDetectorsOutput, AWSError>;
71 /**
72 * 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.
73 */
74 disableAlarmActions(params: CloudWatch.Types.DisableAlarmActionsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
75 /**
76 * 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.
77 */
78 disableAlarmActions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
79 /**
80 * Enables the actions for the specified alarms.
81 */
82 enableAlarmActions(params: CloudWatch.Types.EnableAlarmActionsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
83 /**
84 * Enables the actions for the specified alarms.
85 */
86 enableAlarmActions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
87 /**
88 * 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.
89 */
90 getDashboard(params: CloudWatch.Types.GetDashboardInput, callback?: (err: AWSError, data: CloudWatch.Types.GetDashboardOutput) => void): Request<CloudWatch.Types.GetDashboardOutput, AWSError>;
91 /**
92 * 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.
93 */
94 getDashboard(callback?: (err: AWSError, data: CloudWatch.Types.GetDashboardOutput) => void): Request<CloudWatch.Types.GetDashboardOutput, AWSError>;
95 /**
96 * You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. 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.
97 */
98 getMetricData(params: CloudWatch.Types.GetMetricDataInput, callback?: (err: AWSError, data: CloudWatch.Types.GetMetricDataOutput) => void): Request<CloudWatch.Types.GetMetricDataOutput, AWSError>;
99 /**
100 * You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. 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.
101 */
102 getMetricData(callback?: (err: AWSError, data: CloudWatch.Types.GetMetricDataOutput) => void): Request<CloudWatch.Types.GetMetricDataOutput, AWSError>;
103 /**
104 * 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.
105 */
106 getMetricStatistics(params: CloudWatch.Types.GetMetricStatisticsInput, callback?: (err: AWSError, data: CloudWatch.Types.GetMetricStatisticsOutput) => void): Request<CloudWatch.Types.GetMetricStatisticsOutput, AWSError>;
107 /**
108 * 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.
109 */
110 getMetricStatistics(callback?: (err: AWSError, data: CloudWatch.Types.GetMetricStatisticsOutput) => void): Request<CloudWatch.Types.GetMetricStatisticsOutput, AWSError>;
111 /**
112 * 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.
113 */
114 getMetricWidgetImage(params: CloudWatch.Types.GetMetricWidgetImageInput, callback?: (err: AWSError, data: CloudWatch.Types.GetMetricWidgetImageOutput) => void): Request<CloudWatch.Types.GetMetricWidgetImageOutput, AWSError>;
115 /**
116 * 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.
117 */
118 getMetricWidgetImage(callback?: (err: AWSError, data: CloudWatch.Types.GetMetricWidgetImageOutput) => void): Request<CloudWatch.Types.GetMetricWidgetImageOutput, AWSError>;
119 /**
120 * 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.
121 */
122 listDashboards(params: CloudWatch.Types.ListDashboardsInput, callback?: (err: AWSError, data: CloudWatch.Types.ListDashboardsOutput) => void): Request<CloudWatch.Types.ListDashboardsOutput, AWSError>;
123 /**
124 * 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.
125 */
126 listDashboards(callback?: (err: AWSError, data: CloudWatch.Types.ListDashboardsOutput) => void): Request<CloudWatch.Types.ListDashboardsOutput, AWSError>;
127 /**
128 * 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.
129 */
130 listMetrics(params: CloudWatch.Types.ListMetricsInput, callback?: (err: AWSError, data: CloudWatch.Types.ListMetricsOutput) => void): Request<CloudWatch.Types.ListMetricsOutput, AWSError>;
131 /**
132 * 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.
133 */
134 listMetrics(callback?: (err: AWSError, data: CloudWatch.Types.ListMetricsOutput) => void): Request<CloudWatch.Types.ListMetricsOutput, AWSError>;
135 /**
136 * Displays the tags associated with a CloudWatch resource. Alarms support tagging.
137 */
138 listTagsForResource(params: CloudWatch.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: CloudWatch.Types.ListTagsForResourceOutput) => void): Request<CloudWatch.Types.ListTagsForResourceOutput, AWSError>;
139 /**
140 * Displays the tags associated with a CloudWatch resource. Alarms support tagging.
141 */
142 listTagsForResource(callback?: (err: AWSError, data: CloudWatch.Types.ListTagsForResourceOutput) => void): Request<CloudWatch.Types.ListTagsForResourceOutput, AWSError>;
143 /**
144 * 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.
145 */
146 putAnomalyDetector(params: CloudWatch.Types.PutAnomalyDetectorInput, callback?: (err: AWSError, data: CloudWatch.Types.PutAnomalyDetectorOutput) => void): Request<CloudWatch.Types.PutAnomalyDetectorOutput, AWSError>;
147 /**
148 * 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.
149 */
150 putAnomalyDetector(callback?: (err: AWSError, data: CloudWatch.Types.PutAnomalyDetectorOutput) => void): Request<CloudWatch.Types.PutAnomalyDetectorOutput, AWSError>;
151 /**
152 * 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.
153 */
154 putDashboard(params: CloudWatch.Types.PutDashboardInput, callback?: (err: AWSError, data: CloudWatch.Types.PutDashboardOutput) => void): Request<CloudWatch.Types.PutDashboardOutput, AWSError>;
155 /**
156 * 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.
157 */
158 putDashboard(callback?: (err: AWSError, data: CloudWatch.Types.PutDashboardOutput) => void): Request<CloudWatch.Types.PutDashboardOutput, AWSError>;
159 /**
160 * 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.
161 */
162 putMetricAlarm(params: CloudWatch.Types.PutMetricAlarmInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
163 /**
164 * 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.
165 */
166 putMetricAlarm(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
167 /**
168 * 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 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). 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. 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.
169 */
170 putMetricData(params: CloudWatch.Types.PutMetricDataInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
171 /**
172 * 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 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). 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. 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.
173 */
174 putMetricData(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
175 /**
176 * 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. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.
177 */
178 setAlarmState(params: CloudWatch.Types.SetAlarmStateInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
179 /**
180 * 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. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.
181 */
182 setAlarmState(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
183 /**
184 * Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms. 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 resource.
185 */
186 tagResource(params: CloudWatch.Types.TagResourceInput, callback?: (err: AWSError, data: CloudWatch.Types.TagResourceOutput) => void): Request<CloudWatch.Types.TagResourceOutput, AWSError>;
187 /**
188 * Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms. 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 resource.
189 */
190 tagResource(callback?: (err: AWSError, data: CloudWatch.Types.TagResourceOutput) => void): Request<CloudWatch.Types.TagResourceOutput, AWSError>;
191 /**
192 * Removes one or more tags from the specified resource.
193 */
194 untagResource(params: CloudWatch.Types.UntagResourceInput, callback?: (err: AWSError, data: CloudWatch.Types.UntagResourceOutput) => void): Request<CloudWatch.Types.UntagResourceOutput, AWSError>;
195 /**
196 * Removes one or more tags from the specified resource.
197 */
198 untagResource(callback?: (err: AWSError, data: CloudWatch.Types.UntagResourceOutput) => void): Request<CloudWatch.Types.UntagResourceOutput, AWSError>;
199 /**
200 * Waits for the alarmExists state by periodically calling the underlying CloudWatch.describeAlarmsoperation every 5 seconds (at most 40 times).
201 */
202 waitFor(state: "alarmExists", params: CloudWatch.Types.DescribeAlarmsInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request<CloudWatch.Types.DescribeAlarmsOutput, AWSError>;
203 /**
204 * Waits for the alarmExists state by periodically calling the underlying CloudWatch.describeAlarmsoperation every 5 seconds (at most 40 times).
205 */
206 waitFor(state: "alarmExists", callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request<CloudWatch.Types.DescribeAlarmsOutput, AWSError>;
207}
208declare namespace CloudWatch {
209 export type ActionPrefix = string;
210 export type ActionsEnabled = boolean;
211 export type AlarmArn = string;
212 export type AlarmDescription = string;
213 export interface AlarmHistoryItem {
214 /**
215 * The descriptive name for the alarm.
216 */
217 AlarmName?: AlarmName;
218 /**
219 * The time stamp for the alarm history item.
220 */
221 Timestamp?: Timestamp;
222 /**
223 * The type of alarm history item.
224 */
225 HistoryItemType?: HistoryItemType;
226 /**
227 * A summary of the alarm history, in text format.
228 */
229 HistorySummary?: HistorySummary;
230 /**
231 * Data about the alarm, in JSON format.
232 */
233 HistoryData?: HistoryData;
234 }
235 export type AlarmHistoryItems = AlarmHistoryItem[];
236 export type AlarmName = string;
237 export type AlarmNamePrefix = string;
238 export type AlarmNames = AlarmName[];
239 export type AmazonResourceName = string;
240 export interface AnomalyDetector {
241 /**
242 * The namespace of the metric associated with the anomaly detection model.
243 */
244 Namespace?: Namespace;
245 /**
246 * The name of the metric associated with the anomaly detection model.
247 */
248 MetricName?: MetricName;
249 /**
250 * The metric dimensions associated with the anomaly detection model.
251 */
252 Dimensions?: Dimensions;
253 /**
254 * The statistic associated with the anomaly detection model.
255 */
256 Stat?: Stat;
257 /**
258 * 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.
259 */
260 Configuration?: AnomalyDetectorConfiguration;
261 }
262 export interface AnomalyDetectorConfiguration {
263 /**
264 * 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.
265 */
266 ExcludedTimeRanges?: AnomalyDetectorExcludedTimeRanges;
267 /**
268 * 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.
269 */
270 MetricTimezone?: AnomalyDetectorMetricTimezone;
271 }
272 export type AnomalyDetectorExcludedTimeRanges = Range[];
273 export type AnomalyDetectorMetricTimezone = string;
274 export type AnomalyDetectors = AnomalyDetector[];
275 export type ComparisonOperator = "GreaterThanOrEqualToThreshold"|"GreaterThanThreshold"|"LessThanThreshold"|"LessThanOrEqualToThreshold"|"LessThanLowerOrGreaterThanUpperThreshold"|"LessThanLowerThreshold"|"GreaterThanUpperThreshold"|string;
276 export type Counts = DatapointValue[];
277 export type DashboardArn = string;
278 export type DashboardBody = string;
279 export type DashboardEntries = DashboardEntry[];
280 export interface DashboardEntry {
281 /**
282 * The name of the dashboard.
283 */
284 DashboardName?: DashboardName;
285 /**
286 * The Amazon Resource Name (ARN) of the dashboard.
287 */
288 DashboardArn?: DashboardArn;
289 /**
290 * 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.
291 */
292 LastModified?: LastModified;
293 /**
294 * The size of the dashboard, in bytes.
295 */
296 Size?: Size;
297 }
298 export type DashboardName = string;
299 export type DashboardNamePrefix = string;
300 export type DashboardNames = DashboardName[];
301 export interface DashboardValidationMessage {
302 /**
303 * The data path related to the message.
304 */
305 DataPath?: DataPath;
306 /**
307 * A message describing the error or warning.
308 */
309 Message?: Message;
310 }
311 export type DashboardValidationMessages = DashboardValidationMessage[];
312 export type DataPath = string;
313 export interface Datapoint {
314 /**
315 * The time stamp used for the data point.
316 */
317 Timestamp?: Timestamp;
318 /**
319 * The number of metric values that contributed to the aggregate value of this data point.
320 */
321 SampleCount?: DatapointValue;
322 /**
323 * The average of the metric values that correspond to the data point.
324 */
325 Average?: DatapointValue;
326 /**
327 * The sum of the metric values for the data point.
328 */
329 Sum?: DatapointValue;
330 /**
331 * The minimum metric value for the data point.
332 */
333 Minimum?: DatapointValue;
334 /**
335 * The maximum metric value for the data point.
336 */
337 Maximum?: DatapointValue;
338 /**
339 * The standard unit for the data point.
340 */
341 Unit?: StandardUnit;
342 /**
343 * The percentile statistic for the data point.
344 */
345 ExtendedStatistics?: DatapointValueMap;
346 }
347 export type DatapointValue = number;
348 export type DatapointValueMap = {[key: string]: DatapointValue};
349 export type DatapointValues = DatapointValue[];
350 export type Datapoints = Datapoint[];
351 export type DatapointsToAlarm = number;
352 export interface DeleteAlarmsInput {
353 /**
354 * The alarms to be deleted.
355 */
356 AlarmNames: AlarmNames;
357 }
358 export interface DeleteAnomalyDetectorInput {
359 /**
360 * The namespace associated with the anomaly detection model to delete.
361 */
362 Namespace: Namespace;
363 /**
364 * The metric name associated with the anomaly detection model to delete.
365 */
366 MetricName: MetricName;
367 /**
368 * The metric dimensions associated with the anomaly detection model to delete.
369 */
370 Dimensions?: Dimensions;
371 /**
372 * The statistic associated with the anomaly detection model to delete.
373 */
374 Stat: Stat;
375 }
376 export interface DeleteAnomalyDetectorOutput {
377 }
378 export interface DeleteDashboardsInput {
379 /**
380 * The dashboards to be deleted. This parameter is required.
381 */
382 DashboardNames: DashboardNames;
383 }
384 export interface DeleteDashboardsOutput {
385 }
386 export interface DescribeAlarmHistoryInput {
387 /**
388 * The name of the alarm.
389 */
390 AlarmName?: AlarmName;
391 /**
392 * The type of alarm histories to retrieve.
393 */
394 HistoryItemType?: HistoryItemType;
395 /**
396 * The starting date to retrieve alarm history.
397 */
398 StartDate?: Timestamp;
399 /**
400 * The ending date to retrieve alarm history.
401 */
402 EndDate?: Timestamp;
403 /**
404 * The maximum number of alarm history records to retrieve.
405 */
406 MaxRecords?: MaxRecords;
407 /**
408 * The token returned by a previous call to indicate that there is more data available.
409 */
410 NextToken?: NextToken;
411 }
412 export interface DescribeAlarmHistoryOutput {
413 /**
414 * The alarm histories, in JSON format.
415 */
416 AlarmHistoryItems?: AlarmHistoryItems;
417 /**
418 * The token that marks the start of the next batch of returned results.
419 */
420 NextToken?: NextToken;
421 }
422 export interface DescribeAlarmsForMetricInput {
423 /**
424 * The name of the metric.
425 */
426 MetricName: MetricName;
427 /**
428 * The namespace of the metric.
429 */
430 Namespace: Namespace;
431 /**
432 * The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.
433 */
434 Statistic?: Statistic;
435 /**
436 * The percentile statistic for the metric. Specify a value between p0.0 and p100.
437 */
438 ExtendedStatistic?: ExtendedStatistic;
439 /**
440 * The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.
441 */
442 Dimensions?: Dimensions;
443 /**
444 * The period, in seconds, over which the statistic is applied.
445 */
446 Period?: Period;
447 /**
448 * The unit for the metric.
449 */
450 Unit?: StandardUnit;
451 }
452 export interface DescribeAlarmsForMetricOutput {
453 /**
454 * The information for each alarm with the specified metric.
455 */
456 MetricAlarms?: MetricAlarms;
457 }
458 export interface DescribeAlarmsInput {
459 /**
460 * The names of the alarms.
461 */
462 AlarmNames?: AlarmNames;
463 /**
464 * The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames.
465 */
466 AlarmNamePrefix?: AlarmNamePrefix;
467 /**
468 * The state value to be used in matching alarms.
469 */
470 StateValue?: StateValue;
471 /**
472 * The action name prefix.
473 */
474 ActionPrefix?: ActionPrefix;
475 /**
476 * The maximum number of alarm descriptions to retrieve.
477 */
478 MaxRecords?: MaxRecords;
479 /**
480 * The token returned by a previous call to indicate that there is more data available.
481 */
482 NextToken?: NextToken;
483 }
484 export interface DescribeAlarmsOutput {
485 /**
486 * The information for the specified alarms.
487 */
488 MetricAlarms?: MetricAlarms;
489 /**
490 * The token that marks the start of the next batch of returned results.
491 */
492 NextToken?: NextToken;
493 }
494 export interface DescribeAnomalyDetectorsInput {
495 /**
496 * Use the token returned by the previous operation to request the next page of results.
497 */
498 NextToken?: NextToken;
499 /**
500 * The maximum number of results to return in one operation. The maximum value you can specify is 10. To retrieve the remaining results, make another call with the returned NextToken value.
501 */
502 MaxResults?: MaxReturnedResultsCount;
503 /**
504 * Limits the results to only the anomaly detection models that are associated with the specified namespace.
505 */
506 Namespace?: Namespace;
507 /**
508 * 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.
509 */
510 MetricName?: MetricName;
511 /**
512 * 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.
513 */
514 Dimensions?: Dimensions;
515 }
516 export interface DescribeAnomalyDetectorsOutput {
517 /**
518 * The list of anomaly detection models returned by the operation.
519 */
520 AnomalyDetectors?: AnomalyDetectors;
521 /**
522 * A token that you can use in a subsequent operation to retrieve the next set of results.
523 */
524 NextToken?: NextToken;
525 }
526 export interface Dimension {
527 /**
528 * The name of the dimension.
529 */
530 Name: DimensionName;
531 /**
532 * The value representing the dimension measurement.
533 */
534 Value: DimensionValue;
535 }
536 export interface DimensionFilter {
537 /**
538 * The dimension name to be matched.
539 */
540 Name: DimensionName;
541 /**
542 * The value of the dimension to be matched.
543 */
544 Value?: DimensionValue;
545 }
546 export type DimensionFilters = DimensionFilter[];
547 export type DimensionName = string;
548 export type DimensionValue = string;
549 export type Dimensions = Dimension[];
550 export interface DisableAlarmActionsInput {
551 /**
552 * The names of the alarms.
553 */
554 AlarmNames: AlarmNames;
555 }
556 export interface EnableAlarmActionsInput {
557 /**
558 * The names of the alarms.
559 */
560 AlarmNames: AlarmNames;
561 }
562 export type EvaluateLowSampleCountPercentile = string;
563 export type EvaluationPeriods = number;
564 export type ExtendedStatistic = string;
565 export type ExtendedStatistics = ExtendedStatistic[];
566 export interface GetDashboardInput {
567 /**
568 * The name of the dashboard to be described.
569 */
570 DashboardName: DashboardName;
571 }
572 export interface GetDashboardOutput {
573 /**
574 * The Amazon Resource Name (ARN) of the dashboard.
575 */
576 DashboardArn?: DashboardArn;
577 /**
578 * 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 CloudWatch-Dashboard-Body-Structure.
579 */
580 DashboardBody?: DashboardBody;
581 /**
582 * The name of the dashboard.
583 */
584 DashboardName?: DashboardName;
585 }
586 export interface GetMetricDataInput {
587 /**
588 * The metric queries to be returned. A single GetMetricData call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.
589 */
590 MetricDataQueries: MetricDataQueries;
591 /**
592 * 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.
593 */
594 StartTime: Timestamp;
595 /**
596 * 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.
597 */
598 EndTime: Timestamp;
599 /**
600 * Include this value, if it was returned by the previous call, to get the next set of data points.
601 */
602 NextToken?: NextToken;
603 /**
604 * 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.
605 */
606 ScanBy?: ScanBy;
607 /**
608 * The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.
609 */
610 MaxDatapoints?: GetMetricDataMaxDatapoints;
611 }
612 export type GetMetricDataMaxDatapoints = number;
613 export interface GetMetricDataOutput {
614 /**
615 * The metrics that are returned, including the metric name, namespace, and dimensions.
616 */
617 MetricDataResults?: MetricDataResults;
618 /**
619 * A token that marks the next batch of returned results.
620 */
621 NextToken?: NextToken;
622 /**
623 * 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.
624 */
625 Messages?: MetricDataResultMessages;
626 }
627 export interface GetMetricStatisticsInput {
628 /**
629 * The namespace of the metric, with or without spaces.
630 */
631 Namespace: Namespace;
632 /**
633 * The name of the metric, with or without spaces.
634 */
635 MetricName: MetricName;
636 /**
637 * 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.
638 */
639 Dimensions?: Dimensions;
640 /**
641 * 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. 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.
642 */
643 StartTime: Timestamp;
644 /**
645 * 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. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
646 */
647 EndTime: Timestamp;
648 /**
649 * 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).
650 */
651 Period: Period;
652 /**
653 * The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.
654 */
655 Statistics?: Statistics;
656 /**
657 * 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.
658 */
659 ExtendedStatistics?: ExtendedStatistics;
660 /**
661 * 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.
662 */
663 Unit?: StandardUnit;
664 }
665 export interface GetMetricStatisticsOutput {
666 /**
667 * A label for the specified metric.
668 */
669 Label?: MetricLabel;
670 /**
671 * The data points for the specified metric.
672 */
673 Datapoints?: Datapoints;
674 }
675 export interface GetMetricWidgetImageInput {
676 /**
677 * 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 CloudWatch-Metric-Widget-Structure. 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.
678 */
679 MetricWidget: MetricWidget;
680 /**
681 * 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.
682 */
683 OutputFormat?: OutputFormat;
684 }
685 export interface GetMetricWidgetImageOutput {
686 /**
687 * The image of the graph, in the output format specified.
688 */
689 MetricWidgetImage?: MetricWidgetImage;
690 }
691 export type HistoryData = string;
692 export type HistoryItemType = "ConfigurationUpdate"|"StateUpdate"|"Action"|string;
693 export type HistorySummary = string;
694 export type LastModified = Date;
695 export interface ListDashboardsInput {
696 /**
697 * 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 "_".
698 */
699 DashboardNamePrefix?: DashboardNamePrefix;
700 /**
701 * The token returned by a previous call to indicate that there is more data available.
702 */
703 NextToken?: NextToken;
704 }
705 export interface ListDashboardsOutput {
706 /**
707 * The list of matching dashboards.
708 */
709 DashboardEntries?: DashboardEntries;
710 /**
711 * The token that marks the start of the next batch of returned results.
712 */
713 NextToken?: NextToken;
714 }
715 export interface ListMetricsInput {
716 /**
717 * The namespace to filter against.
718 */
719 Namespace?: Namespace;
720 /**
721 * The name of the metric to filter against.
722 */
723 MetricName?: MetricName;
724 /**
725 * The dimensions to filter against.
726 */
727 Dimensions?: DimensionFilters;
728 /**
729 * The token returned by a previous call to indicate that there is more data available.
730 */
731 NextToken?: NextToken;
732 }
733 export interface ListMetricsOutput {
734 /**
735 * The metrics.
736 */
737 Metrics?: Metrics;
738 /**
739 * The token that marks the start of the next batch of returned results.
740 */
741 NextToken?: NextToken;
742 }
743 export interface ListTagsForResourceInput {
744 /**
745 * The ARN of the CloudWatch resource that you want to view tags for. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference.
746 */
747 ResourceARN: AmazonResourceName;
748 }
749 export interface ListTagsForResourceOutput {
750 /**
751 * The list of tag keys and values associated with the resource you specified.
752 */
753 Tags?: TagList;
754 }
755 export type MaxRecords = number;
756 export type MaxReturnedResultsCount = number;
757 export type Message = string;
758 export interface MessageData {
759 /**
760 * The error code or status code associated with the message.
761 */
762 Code?: MessageDataCode;
763 /**
764 * The message text.
765 */
766 Value?: MessageDataValue;
767 }
768 export type MessageDataCode = string;
769 export type MessageDataValue = string;
770 export interface Metric {
771 /**
772 * The namespace of the metric.
773 */
774 Namespace?: Namespace;
775 /**
776 * The name of the metric. This is a required field.
777 */
778 MetricName?: MetricName;
779 /**
780 * The dimensions for the metric.
781 */
782 Dimensions?: Dimensions;
783 }
784 export interface MetricAlarm {
785 /**
786 * The name of the alarm.
787 */
788 AlarmName?: AlarmName;
789 /**
790 * The Amazon Resource Name (ARN) of the alarm.
791 */
792 AlarmArn?: AlarmArn;
793 /**
794 * The description of the alarm.
795 */
796 AlarmDescription?: AlarmDescription;
797 /**
798 * The time stamp of the last update to the alarm configuration.
799 */
800 AlarmConfigurationUpdatedTimestamp?: Timestamp;
801 /**
802 * Indicates whether actions should be executed during any changes to the alarm state.
803 */
804 ActionsEnabled?: ActionsEnabled;
805 /**
806 * 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).
807 */
808 OKActions?: ResourceList;
809 /**
810 * 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).
811 */
812 AlarmActions?: ResourceList;
813 /**
814 * 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).
815 */
816 InsufficientDataActions?: ResourceList;
817 /**
818 * The state value for the alarm.
819 */
820 StateValue?: StateValue;
821 /**
822 * An explanation for the alarm state, in text format.
823 */
824 StateReason?: StateReason;
825 /**
826 * An explanation for the alarm state, in JSON format.
827 */
828 StateReasonData?: StateReasonData;
829 /**
830 * The time stamp of the last update to the alarm state.
831 */
832 StateUpdatedTimestamp?: Timestamp;
833 /**
834 * The name of the metric associated with the alarm, if this is an alarm based on a single metric.
835 */
836 MetricName?: MetricName;
837 /**
838 * The namespace of the metric associated with the alarm.
839 */
840 Namespace?: Namespace;
841 /**
842 * The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
843 */
844 Statistic?: Statistic;
845 /**
846 * The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
847 */
848 ExtendedStatistic?: ExtendedStatistic;
849 /**
850 * The dimensions for the metric associated with the alarm.
851 */
852 Dimensions?: Dimensions;
853 /**
854 * The period, in seconds, over which the statistic is applied.
855 */
856 Period?: Period;
857 /**
858 * The unit of the metric associated with the alarm.
859 */
860 Unit?: StandardUnit;
861 /**
862 * The number of periods over which data is compared to the specified threshold.
863 */
864 EvaluationPeriods?: EvaluationPeriods;
865 /**
866 * The number of datapoints that must be breaching to trigger the alarm.
867 */
868 DatapointsToAlarm?: DatapointsToAlarm;
869 /**
870 * The value to compare with the specified statistic.
871 */
872 Threshold?: Threshold;
873 /**
874 * The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
875 */
876 ComparisonOperator?: ComparisonOperator;
877 /**
878 * Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.
879 */
880 TreatMissingData?: TreatMissingData;
881 /**
882 * 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.
883 */
884 EvaluateLowSampleCountPercentile?: EvaluateLowSampleCountPercentile;
885 /**
886 * 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.
887 */
888 Metrics?: MetricDataQueries;
889 /**
890 * 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.
891 */
892 ThresholdMetricId?: MetricId;
893 }
894 export type MetricAlarms = MetricAlarm[];
895 export type MetricData = MetricDatum[];
896 export type MetricDataQueries = MetricDataQuery[];
897 export interface MetricDataQuery {
898 /**
899 * 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.
900 */
901 Id: MetricId;
902 /**
903 * 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.
904 */
905 MetricStat?: MetricStat;
906 /**
907 * 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.
908 */
909 Expression?: MetricExpression;
910 /**
911 * 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.
912 */
913 Label?: MetricLabel;
914 /**
915 * 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.
916 */
917 ReturnData?: ReturnData;
918 /**
919 * 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. Use this field only when you are performing a GetMetricData operation, and only when you are specifying the Expression field. Do not use this field with a PutMetricAlarm operation or when you are specifying a MetricStat in a GetMetricData operation.
920 */
921 Period?: Period;
922 }
923 export interface MetricDataResult {
924 /**
925 * The short name you specified to represent this metric.
926 */
927 Id?: MetricId;
928 /**
929 * The human-readable label associated with the data.
930 */
931 Label?: MetricLabel;
932 /**
933 * 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].
934 */
935 Timestamps?: Timestamps;
936 /**
937 * 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].
938 */
939 Values?: DatapointValues;
940 /**
941 * 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.
942 */
943 StatusCode?: StatusCode;
944 /**
945 * A list of messages with additional information about the data returned.
946 */
947 Messages?: MetricDataResultMessages;
948 }
949 export type MetricDataResultMessages = MessageData[];
950 export type MetricDataResults = MetricDataResult[];
951 export interface MetricDatum {
952 /**
953 * The name of the metric.
954 */
955 MetricName: MetricName;
956 /**
957 * The dimensions associated with the metric.
958 */
959 Dimensions?: Dimensions;
960 /**
961 * The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
962 */
963 Timestamp?: Timestamp;
964 /**
965 * 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 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
966 */
967 Value?: DatapointValue;
968 /**
969 * The statistical values for the metric.
970 */
971 StatisticValues?: StatisticSet;
972 /**
973 * 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 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
974 */
975 Values?: Values;
976 /**
977 * 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.
978 */
979 Counts?: Counts;
980 /**
981 * 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.
982 */
983 Unit?: StandardUnit;
984 /**
985 * 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.
986 */
987 StorageResolution?: StorageResolution;
988 }
989 export type MetricExpression = string;
990 export type MetricId = string;
991 export type MetricLabel = string;
992 export type MetricName = string;
993 export interface MetricStat {
994 /**
995 * The metric to return, including the metric name, namespace, and dimensions.
996 */
997 Metric: Metric;
998 /**
999 * 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).
1000 */
1001 Period: Period;
1002 /**
1003 * The statistic to return. It can include any CloudWatch statistic or extended statistic.
1004 */
1005 Stat: Stat;
1006 /**
1007 * 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.
1008 */
1009 Unit?: StandardUnit;
1010 }
1011 export type MetricWidget = string;
1012 export type MetricWidgetImage = Buffer|Uint8Array|Blob|string;
1013 export type Metrics = Metric[];
1014 export type Namespace = string;
1015 export type NextToken = string;
1016 export type OutputFormat = string;
1017 export type Period = number;
1018 export interface PutAnomalyDetectorInput {
1019 /**
1020 * The namespace of the metric to create the anomaly detection model for.
1021 */
1022 Namespace: Namespace;
1023 /**
1024 * The name of the metric to create the anomaly detection model for.
1025 */
1026 MetricName: MetricName;
1027 /**
1028 * The metric dimensions to create the anomaly detection model for.
1029 */
1030 Dimensions?: Dimensions;
1031 /**
1032 * The statistic to use for the metric and the anomaly detection model.
1033 */
1034 Stat: Stat;
1035 /**
1036 * 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
1037 */
1038 Configuration?: AnomalyDetectorConfiguration;
1039 }
1040 export interface PutAnomalyDetectorOutput {
1041 }
1042 export interface PutDashboardInput {
1043 /**
1044 * 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.
1045 */
1046 DashboardName: DashboardName;
1047 /**
1048 * 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 CloudWatch-Dashboard-Body-Structure.
1049 */
1050 DashboardBody: DashboardBody;
1051 }
1052 export interface PutDashboardOutput {
1053 /**
1054 * 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.
1055 */
1056 DashboardValidationMessages?: DashboardValidationMessages;
1057 }
1058 export interface PutMetricAlarmInput {
1059 /**
1060 * The name for the alarm. This name must be unique within your AWS account.
1061 */
1062 AlarmName: AlarmName;
1063 /**
1064 * The description for the alarm.
1065 */
1066 AlarmDescription?: AlarmDescription;
1067 /**
1068 * Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
1069 */
1070 ActionsEnabled?: ActionsEnabled;
1071 /**
1072 * 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-idautoScalingGroupName/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
1073 */
1074 OKActions?: ResourceList;
1075 /**
1076 * 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-idautoScalingGroupName/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
1077 */
1078 AlarmActions?: ResourceList;
1079 /**
1080 * 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-idautoScalingGroupName/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
1081 */
1082 InsufficientDataActions?: ResourceList;
1083 /**
1084 * 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.
1085 */
1086 MetricName?: MetricName;
1087 /**
1088 * The namespace for the metric associated specified in MetricName.
1089 */
1090 Namespace?: Namespace;
1091 /**
1092 * 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.
1093 */
1094 Statistic?: Statistic;
1095 /**
1096 * 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.
1097 */
1098 ExtendedStatistic?: ExtendedStatistic;
1099 /**
1100 * The dimensions for the metric specified in MetricName.
1101 */
1102 Dimensions?: Dimensions;
1103 /**
1104 * 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.
1105 */
1106 Period?: Period;
1107 /**
1108 * 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.
1109 */
1110 Unit?: StandardUnit;
1111 /**
1112 * 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.
1113 */
1114 EvaluationPeriods: EvaluationPeriods;
1115 /**
1116 * The number of datapoints 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.
1117 */
1118 DatapointsToAlarm?: DatapointsToAlarm;
1119 /**
1120 * 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.
1121 */
1122 Threshold?: Threshold;
1123 /**
1124 * 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.
1125 */
1126 ComparisonOperator: ComparisonOperator;
1127 /**
1128 * 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
1129 */
1130 TreatMissingData?: TreatMissingData;
1131 /**
1132 * 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
1133 */
1134 EvaluateLowSampleCountPercentile?: EvaluateLowSampleCountPercentile;
1135 /**
1136 * 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.
1137 */
1138 Metrics?: MetricDataQueries;
1139 /**
1140 * 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.
1141 */
1142 Tags?: TagList;
1143 /**
1144 * 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.
1145 */
1146 ThresholdMetricId?: MetricId;
1147 }
1148 export interface PutMetricDataInput {
1149 /**
1150 * The namespace for the metric data. To avoid conflicts with AWS service namespaces, you should not specify a namespace that begins with AWS/
1151 */
1152 Namespace: Namespace;
1153 /**
1154 * The data for the metric. The array can include no more than 20 metrics per call.
1155 */
1156 MetricData: MetricData;
1157 }
1158 export interface Range {
1159 /**
1160 * 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.
1161 */
1162 StartTime: Timestamp;
1163 /**
1164 * 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.
1165 */
1166 EndTime: Timestamp;
1167 }
1168 export type ResourceList = ResourceName[];
1169 export type ResourceName = string;
1170 export type ReturnData = boolean;
1171 export type ScanBy = "TimestampDescending"|"TimestampAscending"|string;
1172 export interface SetAlarmStateInput {
1173 /**
1174 * The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.
1175 */
1176 AlarmName: AlarmName;
1177 /**
1178 * The value of the state.
1179 */
1180 StateValue: StateValue;
1181 /**
1182 * The reason that this alarm is set to this specific state, in text format.
1183 */
1184 StateReason: StateReason;
1185 /**
1186 * The reason that this alarm is set to this specific state, in JSON format.
1187 */
1188 StateReasonData?: StateReasonData;
1189 }
1190 export type Size = number;
1191 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;
1192 export type Stat = string;
1193 export type StateReason = string;
1194 export type StateReasonData = string;
1195 export type StateValue = "OK"|"ALARM"|"INSUFFICIENT_DATA"|string;
1196 export type Statistic = "SampleCount"|"Average"|"Sum"|"Minimum"|"Maximum"|string;
1197 export interface StatisticSet {
1198 /**
1199 * The number of samples used for the statistic set.
1200 */
1201 SampleCount: DatapointValue;
1202 /**
1203 * The sum of values for the sample set.
1204 */
1205 Sum: DatapointValue;
1206 /**
1207 * The minimum value of the sample set.
1208 */
1209 Minimum: DatapointValue;
1210 /**
1211 * The maximum value of the sample set.
1212 */
1213 Maximum: DatapointValue;
1214 }
1215 export type Statistics = Statistic[];
1216 export type StatusCode = "Complete"|"InternalError"|"PartialData"|string;
1217 export type StorageResolution = number;
1218 export interface Tag {
1219 /**
1220 * 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.
1221 */
1222 Key: TagKey;
1223 /**
1224 * The value for the specified tag key.
1225 */
1226 Value: TagValue;
1227 }
1228 export type TagKey = string;
1229 export type TagKeyList = TagKey[];
1230 export type TagList = Tag[];
1231 export interface TagResourceInput {
1232 /**
1233 * The ARN of the CloudWatch alarm that you're adding tags to. The ARN format is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
1234 */
1235 ResourceARN: AmazonResourceName;
1236 /**
1237 * The list of key-value pairs to associate with the alarm.
1238 */
1239 Tags: TagList;
1240 }
1241 export interface TagResourceOutput {
1242 }
1243 export type TagValue = string;
1244 export type Threshold = number;
1245 export type Timestamp = Date;
1246 export type Timestamps = Timestamp[];
1247 export type TreatMissingData = string;
1248 export interface UntagResourceInput {
1249 /**
1250 * The ARN of the CloudWatch resource that you're removing tags from. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference.
1251 */
1252 ResourceARN: AmazonResourceName;
1253 /**
1254 * The list of tag keys to remove from the resource.
1255 */
1256 TagKeys: TagKeyList;
1257 }
1258 export interface UntagResourceOutput {
1259 }
1260 export type Values = DatapointValue[];
1261 /**
1262 * 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.
1263 */
1264 export type apiVersion = "2010-08-01"|"latest"|string;
1265 export interface ClientApiVersions {
1266 /**
1267 * 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.
1268 */
1269 apiVersion?: apiVersion;
1270 }
1271 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1272 /**
1273 * Contains interfaces for use with the CloudWatch client.
1274 */
1275 export import Types = CloudWatch;
1276}
1277export = CloudWatch;