| 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.SetAlarmState
Description
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. This is not a permanent change. The next
periodic alarm check (in about a minute) will set the alarm to its
actual state.
See: AWS API Reference for SetAlarmState.
- 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
Arguments
| :: Text | |
| -> StateValue | |
| -> Text | |
| -> SetAlarmState |
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.
data SetAlarmStateResponse Source
See: setAlarmStateResponse smart constructor.