Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
This operation returns paginated results.
Synopsis
- 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:
daAlarmNamePrefix
- The alarm name prefix. If this parameter is specified, you cannot specifyAlarmNames
.daActionPrefix
- The action name prefix.daNextToken
- The token returned by a previous call to indicate that there is more data available.daStateValue
- The state value to be used in matching alarms.daAlarmNames
- The names of the alarms.daMaxRecords
- The maximum number of alarm descriptions to retrieve.
data DescribeAlarms Source #
See: describeAlarms
smart constructor.
Instances
Request Lenses
daAlarmNamePrefix :: Lens' DescribeAlarms (Maybe Text) Source #
The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames
.
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 #
The names of the alarms.
daMaxRecords :: Lens' DescribeAlarms (Maybe Natural) Source #
The maximum number of alarm descriptions to retrieve.
Destructuring the Response
describeAlarmsResponse Source #
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:
darsMetricAlarms
- The information for the specified alarms.darsNextToken
- The token that marks the start of the next batch of returned results.darsResponseStatus
- -- | The response status code.
data DescribeAlarmsResponse Source #
See: describeAlarmsResponse
smart constructor.
Instances
Response Lenses
darsMetricAlarms :: Lens' DescribeAlarmsResponse [MetricAlarm] Source #
The information for the specified alarms.
darsNextToken :: Lens' DescribeAlarmsResponse (Maybe Text) Source #
The token that marks the start of the next batch of returned results.
darsResponseStatus :: Lens' DescribeAlarmsResponse Int Source #
- - | The response status code.