| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CloudWatch.DescribeAlarms
Description
Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
See: AWS API Reference for DescribeAlarms.
This operation returns paginated results.
- describeAlarms :: DescribeAlarms
- data DescribeAlarms
- daAlarmNamePrefix :: Lens' DescribeAlarms (Maybe Text)
- daActionPrefix :: Lens' DescribeAlarms (Maybe Text)
- daNextToken :: Lens' DescribeAlarms (Maybe Text)
- daStateValue :: Lens' DescribeAlarms (Maybe StateValue)
- daAlarmNames :: Lens' DescribeAlarms [Text]
- daMaxRecords :: Lens' DescribeAlarms (Maybe Natural)
- describeAlarmsResponse :: Int -> DescribeAlarmsResponse
- data DescribeAlarmsResponse
- darsMetricAlarms :: Lens' DescribeAlarmsResponse [MetricAlarm]
- darsNextToken :: Lens' DescribeAlarmsResponse (Maybe Text)
- darsResponseStatus :: Lens' DescribeAlarmsResponse Int
Creating a Request
describeAlarms :: DescribeAlarms Source
Creates a value of DescribeAlarms with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeAlarms Source
See: describeAlarms smart constructor.
Instances
Request Lenses
daAlarmNamePrefix :: Lens' DescribeAlarms (Maybe Text) Source
The alarm name prefix. AlarmNames cannot be specified if this
parameter is specified.
daActionPrefix :: Lens' DescribeAlarms (Maybe Text) Source
The action name prefix.
daNextToken :: Lens' DescribeAlarms (Maybe Text) Source
The token returned by a previous call to indicate that there is more data available.
daStateValue :: Lens' DescribeAlarms (Maybe StateValue) Source
The state value to be used in matching alarms.
daAlarmNames :: Lens' DescribeAlarms [Text] Source
A list of alarm names to retrieve information for.
daMaxRecords :: Lens' DescribeAlarms (Maybe Natural) Source
The maximum number of alarm descriptions to retrieve.
Destructuring the Response
Arguments
| :: Int | |
| -> DescribeAlarmsResponse |
Creates a value of DescribeAlarmsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeAlarmsResponse Source
The output for the DescribeAlarms action.
See: describeAlarmsResponse smart constructor.
Response Lenses
darsMetricAlarms :: Lens' DescribeAlarmsResponse [MetricAlarm] Source
A list of information for the specified alarms.
darsNextToken :: Lens' DescribeAlarmsResponse (Maybe Text) Source
A string that marks the start of the next batch of returned results.
darsResponseStatus :: Lens' DescribeAlarmsResponse Int Source
The response status code.