amazonka-cloudwatch-1.6.0: Amazon CloudWatch SDK.

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

Network.AWS.CloudWatch.PutMetricAlarm

Contents

Description

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 IAM user, you must have Amazon EC2 permissions for some operations:

  • iam:CreateServiceLinkedRole for all alarms with EC2 actions
  • 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 are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.

If you are using an IAM role (for example, an 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 AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.

You must create at least one stop, terminate, or reboot alarm using either the Amazon EC2 or CloudWatch consoles 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 API.

Synopsis

Creating a Request

putMetricAlarm Source #

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:

  • pmaTreatMissingData - Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data . Valid Values: breaching | notBreaching | ignore | missing
  • 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 | arn:aws:sns:region :account-id :sns-topic-name | arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name Valid Values (for use with IAM roles): arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Stop1.0 | arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Terminate1.0 | arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Reboot/1.0
  • pmaEvaluateLowSampleCountPercentile - Used only for alarms based on percentiles. If you specify ignore , the alarm state does not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples . Valid Values: evaluate | ignore
  • pmaDatapointsToAlarm - The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .
  • 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 | arn:aws:sns:region :account-id :sns-topic-name | arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name Valid Values (for use with IAM roles): arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Stop1.0 | arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Terminate1.0 | arn:aws:swf:region :{account-id }: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 | arn:aws:sns:region :account-id :sns-topic-name | arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name Valid Values (for use with IAM roles): arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Stop1.0 | arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Terminate1.0 | arn:aws:swf:region :{account-id }: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 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 . When you call PutMetricAlarm , you must specify either Statistic or ExtendedStatistic, but not both.
  • pmaExtendedStatistic - The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. When you call PutMetricAlarm , you must specify either Statistic or ExtendedStatistic, but not both.
  • 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. Valid values are 10, 30, and any multiple of 60. Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm may often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing . An alarm's total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.
  • pmaEvaluationPeriods - The number of periods over which data is compared to the specified threshold. If you are setting an alarm which requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N. An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.
  • 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 Source #

See: putMetricAlarm smart constructor.

Instances

Eq PutMetricAlarm Source # 
Data PutMetricAlarm Source # 

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 Source # 
Show PutMetricAlarm Source # 
Generic PutMetricAlarm Source # 

Associated Types

type Rep PutMetricAlarm :: * -> * #

Hashable PutMetricAlarm Source # 
NFData PutMetricAlarm Source # 

Methods

rnf :: PutMetricAlarm -> () #

AWSRequest PutMetricAlarm Source # 
ToHeaders PutMetricAlarm Source # 
ToPath PutMetricAlarm Source # 
ToQuery PutMetricAlarm Source # 
type Rep PutMetricAlarm Source # 
type Rep PutMetricAlarm = D1 * (MetaData "PutMetricAlarm" "Network.AWS.CloudWatch.PutMetricAlarm" "amazonka-cloudwatch-1.6.0-9Bblpq0vnZd2Ryjsugueuz" False) (C1 * (MetaCons "PutMetricAlarm'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_pmaTreatMissingData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (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 "_pmaEvaluateLowSampleCountPercentile") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_pmaDatapointsToAlarm") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (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 DecidedStrict) (Rec0 * Double)) (S1 * (MetaSel (Just Symbol "_pmaComparisonOperator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ComparisonOperator))))))))
type Rs PutMetricAlarm Source # 

Request Lenses

pmaTreatMissingData :: Lens' PutMetricAlarm (Maybe Text) Source #

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data . Valid Values: breaching | notBreaching | ignore | missing

pmaAlarmDescription :: Lens' PutMetricAlarm (Maybe Text) Source #

The description for the alarm.

pmaOKActions :: Lens' PutMetricAlarm [Text] Source #

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 | arn:aws:sns:region :account-id :sns-topic-name | arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name Valid Values (for use with IAM roles): arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Stop1.0 | arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Terminate1.0 | arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Reboot/1.0

pmaEvaluateLowSampleCountPercentile :: Lens' PutMetricAlarm (Maybe Text) Source #

Used only for alarms based on percentiles. If you specify ignore , the alarm state does not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples . Valid Values: evaluate | ignore

pmaDatapointsToAlarm :: Lens' PutMetricAlarm (Maybe Natural) Source #

The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .

pmaActionsEnabled :: Lens' PutMetricAlarm (Maybe Bool) Source #

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

pmaInsufficientDataActions :: Lens' PutMetricAlarm [Text] Source #

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 | arn:aws:sns:region :account-id :sns-topic-name | arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name Valid Values (for use with IAM roles): arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Stop1.0 | arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Terminate1.0 | arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Reboot/1.0

pmaDimensions :: Lens' PutMetricAlarm [Dimension] Source #

The dimensions for the metric associated with the alarm.

pmaAlarmActions :: Lens' PutMetricAlarm [Text] Source #

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 | arn:aws:sns:region :account-id :sns-topic-name | arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name Valid Values (for use with IAM roles): arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Stop1.0 | arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Terminate1.0 | arn:aws:swf:region :{account-id }:actionactionsAWS_EC2.InstanceId.Reboot/1.0

pmaUnit :: Lens' PutMetricAlarm (Maybe StandardUnit) Source #

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 CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.

pmaStatistic :: Lens' PutMetricAlarm (Maybe Statistic) Source #

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic . When you call PutMetricAlarm , you must specify either Statistic or ExtendedStatistic, but not both.

pmaExtendedStatistic :: Lens' PutMetricAlarm (Maybe Text) Source #

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. When you call PutMetricAlarm , you must specify either Statistic or ExtendedStatistic, but not both.

pmaAlarmName :: Lens' PutMetricAlarm Text Source #

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

pmaMetricName :: Lens' PutMetricAlarm Text Source #

The name for the metric associated with the alarm.

pmaNamespace :: Lens' PutMetricAlarm Text Source #

The namespace for the metric associated with the alarm.

pmaPeriod :: Lens' PutMetricAlarm Natural Source #

The period, in seconds, over which the specified statistic is applied. Valid values are 10, 30, and any multiple of 60. Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm may often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing . An alarm's total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.

pmaEvaluationPeriods :: Lens' PutMetricAlarm Natural Source #

The number of periods over which data is compared to the specified threshold. If you are setting an alarm which requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N. An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.

pmaThreshold :: Lens' PutMetricAlarm Double Source #

The value against which the specified statistic is compared.

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.

Destructuring the Response

putMetricAlarmResponse :: PutMetricAlarmResponse Source #

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

data PutMetricAlarmResponse Source #

See: putMetricAlarmResponse smart constructor.

Instances

Eq PutMetricAlarmResponse Source # 
Data PutMetricAlarmResponse Source # 

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 Source # 
Show PutMetricAlarmResponse Source # 
Generic PutMetricAlarmResponse Source # 
NFData PutMetricAlarmResponse Source # 

Methods

rnf :: PutMetricAlarmResponse -> () #

type Rep PutMetricAlarmResponse Source # 
type Rep PutMetricAlarmResponse = D1 * (MetaData "PutMetricAlarmResponse" "Network.AWS.CloudWatch.PutMetricAlarm" "amazonka-cloudwatch-1.6.0-9Bblpq0vnZd2Ryjsugueuz" False) (C1 * (MetaCons "PutMetricAlarmResponse'" PrefixI False) (U1 *))