Network.AWS.CloudWatch.PutMetricAlarm

Creates or updates an alarm and associates it with the specified metric. Optionally, this operation can associate one or more Amazon SNS 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 state is set appropriately. Any actions associated with the state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an AWS Identity and Access Management (IAM) user, you must have Amazon EC2 permissions for some operations:

• ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics
• ec2:StopInstances for alarms with stop actions
• ec2:TerminateInstances for alarms with terminate actions
• ec2:DescribeInstanceRecoveryAttribute and ec2:RecoverInstances for alarms with recover actions

If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions won't be performed. However, if you are later granted the required permissions, the alarm actions that you created earlier will be performed.

If you are using an IAM role (for example, an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.

If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions.

Note that you must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or an API.

Creating a Request

putMetricAlarm

Arguments

:: Text

pmaAlarmName

-> Text

pmaMetricName

-> Text

pmaNamespace

-> Natural

pmaPeriod

-> Natural

pmaEvaluationPeriods

-> Double

pmaThreshold

-> ComparisonOperator

pmaComparisonOperator

-> PutMetricAlarm

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

Use one of the following lenses to modify other fields as desired:

• pmaAlarmDescription - The description for the alarm.
• pmaOKActions - The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: arn:aws:automate:region :ec2:stop | arn:aws:automate:region :ec2:terminate | arn:aws:automate:region :ec2:recover Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Stop1.0 | arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Terminate1.0 | arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Reboot/1.0
• pmaActionsEnabled - Indicates whether actions should be executed during any changes to the alarm state.
• pmaInsufficientDataActions - The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: arn:aws:automate:region :ec2:stop | arn:aws:automate:region :ec2:terminate | arn:aws:automate:region :ec2:recover Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Stop1.0 | arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Terminate1.0 | arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Reboot/1.0
• pmaDimensions - The dimensions for the metric associated with the alarm.
• pmaAlarmActions - The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: arn:aws:automate:region :ec2:stop | arn:aws:automate:region :ec2:terminate | arn:aws:automate:region :ec2:recover Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Stop1.0 | arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Terminate1.0 | arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Reboot/1.0
• pmaUnit - The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately. If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the Amazon CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.
• pmaStatistic - The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic .
• pmaExtendedStatistic - The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
• pmaAlarmName - The name for the alarm. This name must be unique within the AWS account.
• pmaMetricName - The name for the metric associated with the alarm.
• pmaNamespace - The namespace for the metric associated with the alarm.
• pmaPeriod - The period, in seconds, over which the specified statistic is applied.
• pmaEvaluationPeriods - The number of periods over which data is compared to the specified threshold.
• pmaThreshold - The value against which the specified statistic is compared.
• pmaComparisonOperator - The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

data PutMetricAlarm

See: putMetricAlarm smart constructor.

Instances

Eq PutMetricAlarm

Methods

(==) :: PutMetricAlarm -> PutMetricAlarm -> Bool

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

Data PutMetricAlarm

Methods

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

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

toConstr :: PutMetricAlarm -> Constr

dataTypeOf :: PutMetricAlarm -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> PutMetricAlarm -> PutMetricAlarm

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

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

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

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

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

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

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

Read PutMetricAlarm

Methods

readsPrec :: Int -> ReadS PutMetricAlarm

readList :: ReadS [PutMetricAlarm]

readPrec :: ReadPrec PutMetricAlarm

readListPrec :: ReadPrec [PutMetricAlarm]

Show PutMetricAlarm

Methods

showsPrec :: Int -> PutMetricAlarm -> ShowS

show :: PutMetricAlarm -> String

showList :: [PutMetricAlarm] -> ShowS

Generic PutMetricAlarm

Associated Types

type Rep PutMetricAlarm :: * -> *

Methods

from :: PutMetricAlarm -> Rep PutMetricAlarm x

to :: Rep PutMetricAlarm x -> PutMetricAlarm

Hashable PutMetricAlarm

Methods

hashWithSalt :: Int -> PutMetricAlarm -> Int

hash :: PutMetricAlarm -> Int

NFData PutMetricAlarm

Methods

rnf :: PutMetricAlarm -> ()

AWSRequest PutMetricAlarm

Associated Types

type Rs PutMetricAlarm :: *

Methods

request :: PutMetricAlarm -> Request PutMetricAlarm

response :: MonadResource m => Logger -> Service -> Proxy * PutMetricAlarm -> ClientResponse -> m (Response PutMetricAlarm)

ToPath PutMetricAlarm

Methods

toPath :: PutMetricAlarm -> ByteString

ToHeaders PutMetricAlarm

Methods

toHeaders :: PutMetricAlarm -> [Header]

ToQuery PutMetricAlarm

Methods

toQuery :: PutMetricAlarm -> QueryString

type Rep PutMetricAlarm

type Rep PutMetricAlarm = D1 (MetaData "PutMetricAlarm" "Network.AWS.CloudWatch.PutMetricAlarm" "amazonka-cloudwatch-1.4.5-EKf9JeTVY7e7Vri5LpiDhT" False) (C1 (MetaCons "PutMetricAlarm'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pmaAlarmDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pmaOKActions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_pmaActionsEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_pmaInsufficientDataActions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pmaDimensions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Dimension]))) (S1 (MetaSel (Just Symbol "_pmaAlarmActions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_pmaUnit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StandardUnit))) (S1 (MetaSel (Just Symbol "_pmaStatistic") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Statistic)))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pmaExtendedStatistic") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pmaAlarmName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_pmaMetricName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_pmaNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pmaPeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat)) (S1 (MetaSel (Just Symbol "_pmaEvaluationPeriods") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_pmaThreshold") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Double)) (S1 (MetaSel (Just Symbol "_pmaComparisonOperator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ComparisonOperator)))))))

type Rs PutMetricAlarm

type Rs PutMetricAlarm = PutMetricAlarmResponse

Request Lenses

pmaAlarmDescription :: Lens' PutMetricAlarm (Maybe Text)

The description for the alarm.

pmaOKActions :: Lens' PutMetricAlarm [Text]

The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: arn:aws:automate:region :ec2:stop | arn:aws:automate:region :ec2:terminate | arn:aws:automate:region :ec2:recover Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Stop1.0 | arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Terminate1.0 | arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Reboot/1.0

pmaActionsEnabled :: Lens' PutMetricAlarm (Maybe Bool)

Indicates whether actions should be executed during any changes to the alarm state.

pmaInsufficientDataActions :: Lens' PutMetricAlarm [Text]

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: arn:aws:automate:region :ec2:stop | arn:aws:automate:region :ec2:terminate | arn:aws:automate:region :ec2:recover Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Stop1.0 | arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Terminate1.0 | arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Reboot/1.0

pmaDimensions :: Lens' PutMetricAlarm [Dimension]

The dimensions for the metric associated with the alarm.

pmaAlarmActions :: Lens' PutMetricAlarm [Text]

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: arn:aws:automate:region :ec2:stop | arn:aws:automate:region :ec2:terminate | arn:aws:automate:region :ec2:recover Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Stop1.0 | arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Terminate1.0 | arn:aws:swf:us-east-1:{customer-account }:actionactionsAWS_EC2.InstanceId.Reboot/1.0

pmaUnit :: Lens' PutMetricAlarm (Maybe StandardUnit)

The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately. If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the Amazon CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.

pmaStatistic :: Lens' PutMetricAlarm (Maybe Statistic)

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic .

pmaExtendedStatistic :: Lens' PutMetricAlarm (Maybe Text)

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

pmaAlarmName :: Lens' PutMetricAlarm Text

The name for the alarm. This name must be unique within the AWS account.

pmaMetricName :: Lens' PutMetricAlarm Text

The name for the metric associated with the alarm.

pmaNamespace :: Lens' PutMetricAlarm Text

The namespace for the metric associated with the alarm.

pmaPeriod :: Lens' PutMetricAlarm Natural

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

pmaEvaluationPeriods :: Lens' PutMetricAlarm Natural

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

pmaThreshold :: Lens' PutMetricAlarm Double

The value against which the specified statistic is compared.

pmaComparisonOperator :: Lens' PutMetricAlarm ComparisonOperator

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

Destructuring the Response

putMetricAlarmResponse :: PutMetricAlarmResponse

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

data PutMetricAlarmResponse

See: putMetricAlarmResponse smart constructor.

Instances

Eq PutMetricAlarmResponse

Methods

(==) :: PutMetricAlarmResponse -> PutMetricAlarmResponse -> Bool

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

Data PutMetricAlarmResponse

Methods

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

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

toConstr :: PutMetricAlarmResponse -> Constr

dataTypeOf :: PutMetricAlarmResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> PutMetricAlarmResponse -> PutMetricAlarmResponse

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

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

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

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

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

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

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

Read PutMetricAlarmResponse

Methods

readsPrec :: Int -> ReadS PutMetricAlarmResponse

readList :: ReadS [PutMetricAlarmResponse]

readPrec :: ReadPrec PutMetricAlarmResponse

readListPrec :: ReadPrec [PutMetricAlarmResponse]

Show PutMetricAlarmResponse

Methods

showsPrec :: Int -> PutMetricAlarmResponse -> ShowS

show :: PutMetricAlarmResponse -> String

showList :: [PutMetricAlarmResponse] -> ShowS

Generic PutMetricAlarmResponse

Associated Types

type Rep PutMetricAlarmResponse :: * -> *

Methods

from :: PutMetricAlarmResponse -> Rep PutMetricAlarmResponse x

to :: Rep PutMetricAlarmResponse x -> PutMetricAlarmResponse

NFData PutMetricAlarmResponse

Methods

rnf :: PutMetricAlarmResponse -> ()

type Rep PutMetricAlarmResponse

type Rep PutMetricAlarmResponse = D1 (MetaData "PutMetricAlarmResponse" "Network.AWS.CloudWatch.PutMetricAlarm" "amazonka-cloudwatch-1.4.5-EKf9JeTVY7e7Vri5LpiDhT" False) (C1 (MetaCons "PutMetricAlarmResponse'" PrefixI False) U1)