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 |
Temporarily sets the state of an alarm for testing purposes. When the updated state 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 state to ALARM
sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible 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:
sasStateReasonData
- The reason that this alarm is set to this specific state, in JSON format.sasAlarmName
- The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.sasStateValue
- The value of the state.sasStateReason
- The reason that this alarm is set to this specific state, in text format.
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 JSON format.
sasAlarmName :: Lens' SetAlarmState Text Source #
The name for the alarm. This name must be unique within the 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 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.