Copyright | (c) 2013-2016 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 |
Temporarily sets the state of an alarm. When the updated StateValue
differs from the previous value, the action configured for the
appropriate state is invoked. For example, if your alarm is configured
to send an Amazon SNS message when an alarm is triggered, temporarily
changing the alarm's state to ALARM will send an Amazon SNS
message. This is not a permanent change. The next periodic alarm check
(in about a minute) will set the alarm to its actual state. Because the
alarm state change happens very quickly, it is typically only visibile
in the alarm's History tab in the Amazon CloudWatch console or
through DescribeAlarmHistory
.
- setAlarmState :: Text -> StateValue -> Text -> SetAlarmState
- data SetAlarmState
- sasStateReasonData :: Lens' SetAlarmState (Maybe Text)
- sasAlarmName :: Lens' SetAlarmState Text
- sasStateValue :: Lens' SetAlarmState StateValue
- sasStateReason :: Lens' SetAlarmState Text
- setAlarmStateResponse :: SetAlarmStateResponse
- data SetAlarmStateResponse
Creating a Request
Creates a value of SetAlarmState
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data SetAlarmState Source
See: setAlarmState
smart constructor.
Request Lenses
sasStateReasonData :: Lens' SetAlarmState (Maybe Text) Source
The reason that this alarm is set to this specific state (in machine-readable JSON format)
sasAlarmName :: Lens' SetAlarmState Text Source
The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.
sasStateValue :: Lens' SetAlarmState StateValue Source
The value of the state.
sasStateReason :: Lens' SetAlarmState Text Source
The reason that this alarm is set to this specific state (in human-readable text format)
Destructuring the Response
setAlarmStateResponse :: SetAlarmStateResponse Source
Creates a value of SetAlarmStateResponse
with the minimum fields required to make a request.