Network.AWS.CloudWatch.SetAlarmState

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 .

Creating a Request

setAlarmState

Arguments

:: Text

sasAlarmName

-> StateValue

sasStateValue

-> Text

sasStateReason

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

• 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

See: setAlarmState smart constructor.

Instances

Eq SetAlarmState

Defined in Network.AWS.CloudWatch.SetAlarmState

Methods

(==) :: SetAlarmState -> SetAlarmState -> Bool

(/=) :: SetAlarmState -> SetAlarmState -> Bool

Data SetAlarmState

Defined in Network.AWS.CloudWatch.SetAlarmState

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

Defined in Network.AWS.CloudWatch.SetAlarmState

Methods

readsPrec :: Int -> ReadS SetAlarmState

readList :: ReadS [SetAlarmState]

readPrec :: ReadPrec SetAlarmState

readListPrec :: ReadPrec [SetAlarmState]

Show SetAlarmState

Defined in Network.AWS.CloudWatch.SetAlarmState

Methods

showsPrec :: Int -> SetAlarmState -> ShowS

show :: SetAlarmState -> String

showList :: [SetAlarmState] -> ShowS

Generic SetAlarmState

Defined in Network.AWS.CloudWatch.SetAlarmState

Associated Types

type Rep SetAlarmState :: Type -> Type

Methods

from :: SetAlarmState -> Rep SetAlarmState x

to :: Rep SetAlarmState x -> SetAlarmState

Hashable SetAlarmState

Defined in Network.AWS.CloudWatch.SetAlarmState

Methods

hashWithSalt :: Int -> SetAlarmState -> Int

hash :: SetAlarmState -> Int

AWSRequest SetAlarmState

Defined in Network.AWS.CloudWatch.SetAlarmState

Associated Types

type Rs SetAlarmState :: Type

Methods

request :: SetAlarmState -> Request SetAlarmState

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy SetAlarmState -> ClientResponse -> m (Response SetAlarmState)

ToHeaders SetAlarmState

Defined in Network.AWS.CloudWatch.SetAlarmState

Methods

toHeaders :: SetAlarmState -> [Header]

ToPath SetAlarmState

Defined in Network.AWS.CloudWatch.SetAlarmState

Methods

toPath :: SetAlarmState -> ByteString

ToQuery SetAlarmState

Defined in Network.AWS.CloudWatch.SetAlarmState

Methods

toQuery :: SetAlarmState -> QueryString

NFData SetAlarmState

Defined in Network.AWS.CloudWatch.SetAlarmState

Methods

rnf :: SetAlarmState -> ()

type Rep SetAlarmState

Defined in Network.AWS.CloudWatch.SetAlarmState

type Rep SetAlarmState = D1 (MetaData "SetAlarmState" "Network.AWS.CloudWatch.SetAlarmState" "amazonka-cloudwatch-1.6.1-7Rnwowqga1k8zXg3cAhS87" False) (C1 (MetaCons "SetAlarmState'" PrefixI True) ((S1 (MetaSel (Just "_sasStateReasonData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sasAlarmName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_sasStateValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 StateValue) :*: S1 (MetaSel (Just "_sasStateReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs SetAlarmState

Defined in Network.AWS.CloudWatch.SetAlarmState

type Rs SetAlarmState = SetAlarmStateResponse

Request Lenses

sasStateReasonData :: Lens' SetAlarmState (Maybe Text)

The reason that this alarm is set to this specific state, in JSON format.

sasAlarmName :: Lens' SetAlarmState Text

The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.

sasStateValue :: Lens' SetAlarmState StateValue

The value of the state.

sasStateReason :: Lens' SetAlarmState Text

The reason that this alarm is set to this specific state, in text format.

Destructuring the Response

setAlarmStateResponse :: SetAlarmStateResponse

Creates a value of SetAlarmStateResponse with the minimum fields required to make a request.

data SetAlarmStateResponse

See: setAlarmStateResponse smart constructor.

Instances

Eq SetAlarmStateResponse

Defined in Network.AWS.CloudWatch.SetAlarmState

Methods

(==) :: SetAlarmStateResponse -> SetAlarmStateResponse -> Bool

(/=) :: SetAlarmStateResponse -> SetAlarmStateResponse -> Bool

Data SetAlarmStateResponse

Defined in Network.AWS.CloudWatch.SetAlarmState

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

Defined in Network.AWS.CloudWatch.SetAlarmState

Methods

readsPrec :: Int -> ReadS SetAlarmStateResponse

readList :: ReadS [SetAlarmStateResponse]

readPrec :: ReadPrec SetAlarmStateResponse

readListPrec :: ReadPrec [SetAlarmStateResponse]

Show SetAlarmStateResponse

Defined in Network.AWS.CloudWatch.SetAlarmState

Methods

showsPrec :: Int -> SetAlarmStateResponse -> ShowS

show :: SetAlarmStateResponse -> String

showList :: [SetAlarmStateResponse] -> ShowS

Generic SetAlarmStateResponse

Defined in Network.AWS.CloudWatch.SetAlarmState

Associated Types

type Rep SetAlarmStateResponse :: Type -> Type

Methods

from :: SetAlarmStateResponse -> Rep SetAlarmStateResponse x

to :: Rep SetAlarmStateResponse x -> SetAlarmStateResponse

NFData SetAlarmStateResponse

Defined in Network.AWS.CloudWatch.SetAlarmState

Methods

rnf :: SetAlarmStateResponse -> ()

type Rep SetAlarmStateResponse

Defined in Network.AWS.CloudWatch.SetAlarmState

type Rep SetAlarmStateResponse = D1 (MetaData "SetAlarmStateResponse" "Network.AWS.CloudWatch.SetAlarmState" "amazonka-cloudwatch-1.6.1-7Rnwowqga1k8zXg3cAhS87" False) (C1 (MetaCons "SetAlarmStateResponse'" PrefixI False) (U1 :: Type -> Type))