| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CloudWatch.PutMetricAlarm
Description
Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.
Alarms based on anomaly detection models cannot have Auto Scaling actions.
When this operation creates an alarm, the alarm state is immediately set
to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set
appropriately. Any actions associated with the new 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 alarm operations:
- The
iam:CreateServiceLinkedRolefor all alarms with EC2 actions - The
iam:CreateServiceLinkedRoleto create an alarm with Systems Manager OpsItem actions.
The first time you create an alarm in the Management Console, the CLI,
or by using the PutMetricAlarm API, CloudWatch creates the necessary
service-linked role for you. The service-linked roles are called
AWSServiceRoleForCloudWatchEvents and
AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see
Amazon Web Services service-linked role.
Cross-account alarms
You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:
- The account where the metrics are located (the sharing account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the instructions in __Set up a sharing account__ in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the account where you are creating the alarm.
- The account where you are creating the alarm (the /monitoring account/) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in __Set up a monitoring account__ in Cross-account cross-Region CloudWatch console.
Synopsis
- data PutMetricAlarm = PutMetricAlarm' {
- metrics :: Maybe [MetricDataQuery]
- treatMissingData :: Maybe Text
- period :: Maybe Natural
- alarmDescription :: Maybe Text
- metricName :: Maybe Text
- namespace :: Maybe Text
- thresholdMetricId :: Maybe Text
- oKActions :: Maybe [Text]
- evaluateLowSampleCountPercentile :: Maybe Text
- datapointsToAlarm :: Maybe Natural
- threshold :: Maybe Double
- actionsEnabled :: Maybe Bool
- insufficientDataActions :: Maybe [Text]
- dimensions :: Maybe [Dimension]
- alarmActions :: Maybe [Text]
- unit :: Maybe StandardUnit
- statistic :: Maybe Statistic
- tags :: Maybe [Tag]
- extendedStatistic :: Maybe Text
- alarmName :: Text
- evaluationPeriods :: Natural
- comparisonOperator :: ComparisonOperator
- newPutMetricAlarm :: Text -> Natural -> ComparisonOperator -> PutMetricAlarm
- putMetricAlarm_metrics :: Lens' PutMetricAlarm (Maybe [MetricDataQuery])
- putMetricAlarm_treatMissingData :: Lens' PutMetricAlarm (Maybe Text)
- putMetricAlarm_period :: Lens' PutMetricAlarm (Maybe Natural)
- putMetricAlarm_alarmDescription :: Lens' PutMetricAlarm (Maybe Text)
- putMetricAlarm_metricName :: Lens' PutMetricAlarm (Maybe Text)
- putMetricAlarm_namespace :: Lens' PutMetricAlarm (Maybe Text)
- putMetricAlarm_thresholdMetricId :: Lens' PutMetricAlarm (Maybe Text)
- putMetricAlarm_oKActions :: Lens' PutMetricAlarm (Maybe [Text])
- putMetricAlarm_evaluateLowSampleCountPercentile :: Lens' PutMetricAlarm (Maybe Text)
- putMetricAlarm_datapointsToAlarm :: Lens' PutMetricAlarm (Maybe Natural)
- putMetricAlarm_threshold :: Lens' PutMetricAlarm (Maybe Double)
- putMetricAlarm_actionsEnabled :: Lens' PutMetricAlarm (Maybe Bool)
- putMetricAlarm_insufficientDataActions :: Lens' PutMetricAlarm (Maybe [Text])
- putMetricAlarm_dimensions :: Lens' PutMetricAlarm (Maybe [Dimension])
- putMetricAlarm_alarmActions :: Lens' PutMetricAlarm (Maybe [Text])
- putMetricAlarm_unit :: Lens' PutMetricAlarm (Maybe StandardUnit)
- putMetricAlarm_statistic :: Lens' PutMetricAlarm (Maybe Statistic)
- putMetricAlarm_tags :: Lens' PutMetricAlarm (Maybe [Tag])
- putMetricAlarm_extendedStatistic :: Lens' PutMetricAlarm (Maybe Text)
- putMetricAlarm_alarmName :: Lens' PutMetricAlarm Text
- putMetricAlarm_evaluationPeriods :: Lens' PutMetricAlarm Natural
- putMetricAlarm_comparisonOperator :: Lens' PutMetricAlarm ComparisonOperator
- data PutMetricAlarmResponse = PutMetricAlarmResponse' {
- newPutMetricAlarmResponse :: PutMetricAlarmResponse
Creating a Request
data PutMetricAlarm Source #
See: newPutMetricAlarm smart constructor.
Constructors
| PutMetricAlarm' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Natural | |
| -> ComparisonOperator | |
| -> PutMetricAlarm |
Create a value of PutMetricAlarm with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metrics:PutMetricAlarm', putMetricAlarm_metrics - An array of MetricDataQuery structures that enable you to create an
alarm based on the result of a metric math expression. For each
PutMetricAlarm operation, you must specify either MetricName or a
Metrics array.
Each item in the Metrics array either retrieves a metric or performs a
math expression.
One item in the Metrics array is the expression that the alarm
watches. You designate this expression by setting ReturnData to true
for this object in the array. For more information, see
MetricDataQuery.
If you use the Metrics parameter, you cannot include the MetricName,
Dimensions, Period, Namespace, Statistic, or ExtendedStatistic
parameters of PutMetricAlarm in the same operation. Instead, you
retrieve the metrics you are using in your math expression as part of
the Metrics array.
$sel:treatMissingData:PutMetricAlarm', putMetricAlarm_treatMissingData - 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
$sel:period:PutMetricAlarm', putMetricAlarm_period - The length, in seconds, used each time the metric specified in
MetricName is evaluated. Valid values are 10, 30, and any multiple of
60.
Period is required for alarms based on static thresholds. If you are
creating an alarm based on a metric math expression, you specify the
period for each metric within the objects in the Metrics array.
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 might 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.
$sel:alarmDescription:PutMetricAlarm', putMetricAlarm_alarmDescription - The description for the alarm.
$sel:metricName:PutMetricAlarm', putMetricAlarm_metricName - The name for the metric associated with the alarm. For each
PutMetricAlarm operation, you must specify either MetricName or a
Metrics array.
If you are creating an alarm based on a math expression, you cannot
specify this parameter, or any of the Dimensions, Period,
Namespace, Statistic, or ExtendedStatistic parameters. Instead,
you specify all this information in the Metrics array.
$sel:namespace:PutMetricAlarm', putMetricAlarm_namespace - The namespace for the metric associated specified in MetricName.
$sel:thresholdMetricId:PutMetricAlarm', putMetricAlarm_thresholdMetricId - If this is an alarm based on an anomaly detection model, make this value
match the ID of the ANOMALY_DETECTION_BAND function.
For an example of how to use this parameter, see the __Anomaly Detection Model Alarm__ example on this page.
If your alarm uses this parameter, it cannot have Auto Scaling actions.
$sel:oKActions:PutMetricAlarm', putMetricAlarm_oKActions - 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:automate:region:ec2:reboot |
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:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
$sel:evaluateLowSampleCountPercentile:PutMetricAlarm', putMetricAlarm_evaluateLowSampleCountPercentile - 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
$sel:datapointsToAlarm:PutMetricAlarm', putMetricAlarm_datapointsToAlarm - The number of data points 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.
$sel:threshold:PutMetricAlarm', putMetricAlarm_threshold - The value against which the specified statistic is compared.
This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
$sel:actionsEnabled:PutMetricAlarm', putMetricAlarm_actionsEnabled - Indicates whether actions should be executed during any changes to the
alarm state. The default is TRUE.
$sel:insufficientDataActions:PutMetricAlarm', putMetricAlarm_insufficientDataActions - 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:automate:region:ec2:reboot |
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:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
$sel:dimensions:PutMetricAlarm', putMetricAlarm_dimensions - The dimensions for the metric specified in MetricName.
$sel:alarmActions:PutMetricAlarm', putMetricAlarm_alarmActions - 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:automate:region:ec2:reboot |
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
| arn:aws:ssm:region:account-id:opsitem:severity |
arn:aws:ssm-incidents::account-id:response-plan:response-plan-name
Valid Values (for use with IAM roles):
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
$sel:unit:PutMetricAlarm', putMetricAlarm_unit - 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 don't specify Unit, CloudWatch retrieves all unit types that
have been published for the metric and attempts to evaluate the alarm.
Usually, metrics are published with only one unit, so the alarm works as
intended.
However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves predictably.
We recommend omitting Unit so that you don't inadvertently specify an
incorrect unit that is not published for this metric. Doing so causes
the alarm to be stuck in the INSUFFICIENT DATA state.
$sel:statistic:PutMetricAlarm', putMetricAlarm_statistic - The statistic for the metric specified in MetricName, other than
percentile. For percentile statistics, use ExtendedStatistic. When you
call PutMetricAlarm and specify a MetricName, you must specify
either Statistic or ExtendedStatistic, but not both.
$sel:tags:PutMetricAlarm', putMetricAlarm_tags - A list of key-value pairs to associate with the alarm. You can associate
as many as 50 tags with an alarm.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
$sel:extendedStatistic:PutMetricAlarm', putMetricAlarm_extendedStatistic - The percentile statistic for the metric specified in MetricName.
Specify a value between p0.0 and p100. When you call PutMetricAlarm
and specify a MetricName, you must specify either Statistic or
ExtendedStatistic, but not both.
$sel:alarmName:PutMetricAlarm', putMetricAlarm_alarmName - The name for the alarm. This name must be unique within the Region.
$sel:evaluationPeriods:PutMetricAlarm', putMetricAlarm_evaluationPeriods - The number of periods over which data is compared to the specified
threshold. If you are setting an alarm that 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.
$sel:comparisonOperator:PutMetricAlarm', putMetricAlarm_comparisonOperator - The arithmetic operation to use when comparing the specified statistic
and threshold. The specified statistic value is used as the first
operand.
The values LessThanLowerOrGreaterThanUpperThreshold,
LessThanLowerThreshold, and GreaterThanUpperThreshold are used only
for alarms based on anomaly detection models.
Request Lenses
putMetricAlarm_metrics :: Lens' PutMetricAlarm (Maybe [MetricDataQuery]) Source #
An array of MetricDataQuery structures that enable you to create an
alarm based on the result of a metric math expression. For each
PutMetricAlarm operation, you must specify either MetricName or a
Metrics array.
Each item in the Metrics array either retrieves a metric or performs a
math expression.
One item in the Metrics array is the expression that the alarm
watches. You designate this expression by setting ReturnData to true
for this object in the array. For more information, see
MetricDataQuery.
If you use the Metrics parameter, you cannot include the MetricName,
Dimensions, Period, Namespace, Statistic, or ExtendedStatistic
parameters of PutMetricAlarm in the same operation. Instead, you
retrieve the metrics you are using in your math expression as part of
the Metrics array.
putMetricAlarm_treatMissingData :: 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
putMetricAlarm_period :: Lens' PutMetricAlarm (Maybe Natural) Source #
The length, in seconds, used each time the metric specified in
MetricName is evaluated. Valid values are 10, 30, and any multiple of
60.
Period is required for alarms based on static thresholds. If you are
creating an alarm based on a metric math expression, you specify the
period for each metric within the objects in the Metrics array.
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 might 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.
putMetricAlarm_alarmDescription :: Lens' PutMetricAlarm (Maybe Text) Source #
The description for the alarm.
putMetricAlarm_metricName :: Lens' PutMetricAlarm (Maybe Text) Source #
The name for the metric associated with the alarm. For each
PutMetricAlarm operation, you must specify either MetricName or a
Metrics array.
If you are creating an alarm based on a math expression, you cannot
specify this parameter, or any of the Dimensions, Period,
Namespace, Statistic, or ExtendedStatistic parameters. Instead,
you specify all this information in the Metrics array.
putMetricAlarm_namespace :: Lens' PutMetricAlarm (Maybe Text) Source #
The namespace for the metric associated specified in MetricName.
putMetricAlarm_thresholdMetricId :: Lens' PutMetricAlarm (Maybe Text) Source #
If this is an alarm based on an anomaly detection model, make this value
match the ID of the ANOMALY_DETECTION_BAND function.
For an example of how to use this parameter, see the __Anomaly Detection Model Alarm__ example on this page.
If your alarm uses this parameter, it cannot have Auto Scaling actions.
putMetricAlarm_oKActions :: Lens' PutMetricAlarm (Maybe [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:automate:region:ec2:reboot |
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:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
putMetricAlarm_evaluateLowSampleCountPercentile :: 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
putMetricAlarm_datapointsToAlarm :: Lens' PutMetricAlarm (Maybe Natural) Source #
The number of data points 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.
putMetricAlarm_threshold :: Lens' PutMetricAlarm (Maybe Double) Source #
The value against which the specified statistic is compared.
This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
putMetricAlarm_actionsEnabled :: Lens' PutMetricAlarm (Maybe Bool) Source #
Indicates whether actions should be executed during any changes to the
alarm state. The default is TRUE.
putMetricAlarm_insufficientDataActions :: Lens' PutMetricAlarm (Maybe [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:automate:region:ec2:reboot |
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:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
putMetricAlarm_dimensions :: Lens' PutMetricAlarm (Maybe [Dimension]) Source #
The dimensions for the metric specified in MetricName.
putMetricAlarm_alarmActions :: Lens' PutMetricAlarm (Maybe [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:automate:region:ec2:reboot |
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
| arn:aws:ssm:region:account-id:opsitem:severity |
arn:aws:ssm-incidents::account-id:response-plan:response-plan-name
Valid Values (for use with IAM roles):
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
putMetricAlarm_unit :: 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 don't specify Unit, CloudWatch retrieves all unit types that
have been published for the metric and attempts to evaluate the alarm.
Usually, metrics are published with only one unit, so the alarm works as
intended.
However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves predictably.
We recommend omitting Unit so that you don't inadvertently specify an
incorrect unit that is not published for this metric. Doing so causes
the alarm to be stuck in the INSUFFICIENT DATA state.
putMetricAlarm_statistic :: Lens' PutMetricAlarm (Maybe Statistic) Source #
The statistic for the metric specified in MetricName, other than
percentile. For percentile statistics, use ExtendedStatistic. When you
call PutMetricAlarm and specify a MetricName, you must specify
either Statistic or ExtendedStatistic, but not both.
putMetricAlarm_tags :: Lens' PutMetricAlarm (Maybe [Tag]) Source #
A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
putMetricAlarm_extendedStatistic :: Lens' PutMetricAlarm (Maybe Text) Source #
The percentile statistic for the metric specified in MetricName.
Specify a value between p0.0 and p100. When you call PutMetricAlarm
and specify a MetricName, you must specify either Statistic or
ExtendedStatistic, but not both.
putMetricAlarm_alarmName :: Lens' PutMetricAlarm Text Source #
The name for the alarm. This name must be unique within the Region.
putMetricAlarm_evaluationPeriods :: Lens' PutMetricAlarm Natural Source #
The number of periods over which data is compared to the specified threshold. If you are setting an alarm that 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.
putMetricAlarm_comparisonOperator :: 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.
The values LessThanLowerOrGreaterThanUpperThreshold,
LessThanLowerThreshold, and GreaterThanUpperThreshold are used only
for alarms based on anomaly detection models.
Destructuring the Response
data PutMetricAlarmResponse Source #
See: newPutMetricAlarmResponse smart constructor.
Constructors
| PutMetricAlarmResponse' | |
Instances
newPutMetricAlarmResponse :: PutMetricAlarmResponse Source #
Create a value of PutMetricAlarmResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.