Safe Haskell	None
Language	Haskell2010

Network.AWS.CloudWatch.PutMetricAlarm

Contents

Request
- Request constructor
- Request lenses
Response
- Response constructor

Description

Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is evaluated and its StateValue is set appropriately. Any actions associated with the StateValue is then executed.

http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html

Synopsis

Request

data PutMetricAlarm Source

Instances

Eq PutMetricAlarm
Read PutMetricAlarm
Show PutMetricAlarm
AWSRequest PutMetricAlarm
ToQuery PutMetricAlarm
ToPath PutMetricAlarm
ToHeaders PutMetricAlarm
type Sv PutMetricAlarm = CloudWatch
type Rs PutMetricAlarm = PutMetricAlarmResponse

Request constructor

putMetricAlarm Source

Arguments

:: Text	`pmaAlarmName`
-> Text	`pmaMetricName`
-> Text	`pmaNamespace`
-> Statistic	`pmaStatistic`
-> Natural	`pmaPeriod`
-> Natural	`pmaEvaluationPeriods`
-> Double	`pmaThreshold`
-> ComparisonOperator	`pmaComparisonOperator`
-> PutMetricAlarm

PutMetricAlarm constructor.

The fields accessible through corresponding lenses are:

pmaActionsEnabled :: Maybe Bool
pmaAlarmActions :: [Text]
pmaAlarmDescription :: Maybe Text
pmaAlarmName :: Text
pmaComparisonOperator :: ComparisonOperator
pmaDimensions :: [Dimension]
pmaEvaluationPeriods :: Natural
pmaInsufficientDataActions :: [Text]
pmaMetricName :: Text
pmaNamespace :: Text
pmaOKActions :: [Text]
pmaPeriod :: Natural
pmaStatistic :: Statistic
pmaThreshold :: Double
pmaUnit :: Maybe StandardUnit

Request lenses

pmaActionsEnabled :: Lens' PutMetricAlarm (Maybe Bool) Source

Indicates whether or not actions should be executed during any changes to the alarm's state.

pmaAlarmActions :: Lens' PutMetricAlarm [Text] Source

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.

pmaAlarmDescription :: Lens' PutMetricAlarm (Maybe Text) Source

The description for the alarm.

pmaAlarmName :: Lens' PutMetricAlarm Text Source

The descriptive name for the alarm. This name must be unique within the user's AWS account

pmaComparisonOperator :: Lens' PutMetricAlarm ComparisonOperator Source

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

pmaDimensions :: Lens' PutMetricAlarm [Dimension] Source

The dimensions for the alarm's associated metric.

pmaEvaluationPeriods :: Lens' PutMetricAlarm Natural Source

The number of periods over which data is compared to the specified threshold.

pmaInsufficientDataActions :: Lens' PutMetricAlarm [Text] Source

The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.

pmaMetricName :: Lens' PutMetricAlarm Text Source

The name for the alarm's associated metric.

pmaNamespace :: Lens' PutMetricAlarm Text Source

The namespace for the alarm's associated metric.

pmaOKActions :: Lens' PutMetricAlarm [Text] Source

The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.

pmaPeriod :: Lens' PutMetricAlarm Natural Source

The period in seconds over which the specified statistic is applied.

pmaStatistic :: Lens' PutMetricAlarm Statistic Source

The statistic to apply to the alarm's associated metric.

pmaThreshold :: Lens' PutMetricAlarm Double Source

The value against which the specified statistic is compared.

pmaUnit :: Lens' PutMetricAlarm (Maybe StandardUnit) Source

The unit for the alarm's associated metric.

Response

data PutMetricAlarmResponse Source

Instances

Eq PutMetricAlarmResponse
Ord PutMetricAlarmResponse
Read PutMetricAlarmResponse
Show PutMetricAlarmResponse
Generic PutMetricAlarmResponse
type Rep PutMetricAlarmResponse

Response constructor

putMetricAlarmResponse :: PutMetricAlarmResponse Source

PutMetricAlarmResponse constructor.