amazonka-cloudwatch-1.4.1: Amazon CloudWatch SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudWatch.SetAlarmState

Contents

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. 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.

Synopsis

Creating a Request

setAlarmState Source #

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.

Instances

Eq SetAlarmState Source # 
Data SetAlarmState Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetAlarmState -> c SetAlarmState #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetAlarmState #

toConstr :: SetAlarmState -> Constr #

dataTypeOf :: SetAlarmState -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SetAlarmState) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetAlarmState) #

gmapT :: (forall b. Data b => b -> b) -> SetAlarmState -> SetAlarmState #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetAlarmState -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetAlarmState -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetAlarmState -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetAlarmState -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetAlarmState -> m SetAlarmState #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetAlarmState -> m SetAlarmState #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetAlarmState -> m SetAlarmState #

Read SetAlarmState Source # 
Show SetAlarmState Source # 
Generic SetAlarmState Source # 

Associated Types

type Rep SetAlarmState :: * -> * #

Hashable SetAlarmState Source # 
NFData SetAlarmState Source # 

Methods

rnf :: SetAlarmState -> () #

AWSRequest SetAlarmState Source # 
ToQuery SetAlarmState Source # 
ToPath SetAlarmState Source # 
ToHeaders SetAlarmState Source # 
type Rep SetAlarmState Source # 
type Rep SetAlarmState = D1 (MetaData "SetAlarmState" "Network.AWS.CloudWatch.SetAlarmState" "amazonka-cloudwatch-1.4.1-LEQHaHRJY9mEUXBa7VTlqQ" False) (C1 (MetaCons "SetAlarmState'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sasStateReasonData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sasAlarmName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_sasStateValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 StateValue)) (S1 (MetaSel (Just Symbol "_sasStateReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs SetAlarmState Source # 

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.

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.

Instances

Eq SetAlarmStateResponse Source # 
Data SetAlarmStateResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetAlarmStateResponse -> c SetAlarmStateResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetAlarmStateResponse #

toConstr :: SetAlarmStateResponse -> Constr #

dataTypeOf :: SetAlarmStateResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SetAlarmStateResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetAlarmStateResponse) #

gmapT :: (forall b. Data b => b -> b) -> SetAlarmStateResponse -> SetAlarmStateResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetAlarmStateResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetAlarmStateResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetAlarmStateResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetAlarmStateResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetAlarmStateResponse -> m SetAlarmStateResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetAlarmStateResponse -> m SetAlarmStateResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetAlarmStateResponse -> m SetAlarmStateResponse #

Read SetAlarmStateResponse Source # 
Show SetAlarmStateResponse Source # 
Generic SetAlarmStateResponse Source # 
NFData SetAlarmStateResponse Source # 

Methods

rnf :: SetAlarmStateResponse -> () #

type Rep SetAlarmStateResponse Source # 
type Rep SetAlarmStateResponse = D1 (MetaData "SetAlarmStateResponse" "Network.AWS.CloudWatch.SetAlarmState" "amazonka-cloudwatch-1.4.1-LEQHaHRJY9mEUXBa7VTlqQ" False) (C1 (MetaCons "SetAlarmStateResponse'" PrefixI False) U1)