DescribeAlarms
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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ActionPrefix
The action name prefix.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- AlarmNamePrefix
The alarm name prefix. You cannot specify
AlarmNamesif this parameter is specified.Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- AlarmNames.member.N
The names of the alarms.
Type: array of Strings
Array Members: Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- MaxRecords
The maximum number of alarm descriptions to retrieve.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
The token returned by a previous call to indicate that there is more data available.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- StateValue
The state value to be used in matching alarms.
Type: String
Valid Values:
OK | ALARM | INSUFFICIENT_DATARequired: No
Response Elements
The following elements are returned by the service.
- MetricAlarms.member.N
The information for the specified alarms.
Type: array of MetricAlarm objects
- NextToken
The token that marks the start of the next batch of returned results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Errors
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:
