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

DescribeAlarmsForMetric

Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.

Request Parameters

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

Dimensions.member.N

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

Type: array of Dimension objects

Array Members: Maximum number of 10 items.

Required: No

MetricName

The name of the metric.

Type: String

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

Required: Yes

Namespace

The namespace of the metric.

Type: String

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

Pattern: [^:].*

Required: Yes

Period

The period in seconds over which the statistic is applied.

Type: Integer

Valid Range: Minimum value of 60.

Required: No

Statistic

The statistic for the metric.

Type: String

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

Required: No

Unit

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.

MetricAlarms.member.N

A list of information for each alarm with the specified metric.

Type: array of MetricAlarm objects

Errors

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