Amazon CloudWatch
API Reference (API Version 2010-08-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.


The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.

Type: Array of Dimension objects

Array Members: Maximum number of 10 items.

Required: No


The percentile statistic for the metric. Specify a value between p0.0 and p100.

Type: String

Pattern: p(\d{1,2}(\.\d{0,2})?|100)

Required: No


The name of the metric.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes


The namespace of the metric.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^:].*

Required: Yes


The period, in seconds, over which the statistic is applied.

Type: Integer

Valid Range: Minimum value of 1.

Required: No


The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.

Type: String

Valid Values: SampleCount | Average | Sum | Minimum | Maximum

Required: No


The unit for the metric.

Type: String

Valid Values: 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

Required: No

Response Elements

The following element is returned by the service.


The information for each alarm with the specified metric.

Type: Array of MetricAlarm objects


For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: