v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1476259373.1 KB

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

This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

get/#Action=DescribeAlarmsForMetric

Query parameters

MetricNamestring required

The name of the metric.

Namespacestring required

The namespace of the metric.

Statistic'SampleCount' | 'Average' | 'Sum' | 'Minimum' | 'Maximum'

The statistic for the metric, other than percentiles. For percentile statistics, use <code>ExtendedStatistics</code>.

ExtendedStatisticstring

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

Namestring required

The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (<code>:</code>). ASCII control characters are not supported as part of dimension names.

Valuestring required

The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

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

Periodinteger

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

Unit'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'

The unit for the metric.

Action'DescribeAlarmsForMetric' required
Version'2010-08-01' required

Response

Success