Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query. For more information about using a Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.
See https://www.paws-r-sdk.com/docs/cloudwatch_put_metric_alarm/ for full documentation.
cloudwatch_put_metric_alarm(
AlarmName,
AlarmDescription = NULL,
ActionsEnabled = NULL,
OKActions = NULL,
AlarmActions = NULL,
InsufficientDataActions = NULL,
MetricName = NULL,
Namespace = NULL,
Statistic = NULL,
ExtendedStatistic = NULL,
Dimensions = NULL,
Period = NULL,
Unit = NULL,
EvaluationPeriods,
DatapointsToAlarm = NULL,
Threshold = NULL,
ComparisonOperator,
TreatMissingData = NULL,
EvaluateLowSampleCountPercentile = NULL,
Metrics = NULL,
Tags = NULL,
ThresholdMetricId = NULL
)[required] The name for the alarm. This name must be unique within the Region.
The name must contain only UTF-8 characters, and can't contain ASCII control characters
The description for the alarm.
Indicates whether actions should be executed during any changes to the
alarm state. The default is TRUE.
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:
EC2 actions:
arn:aws:automate:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:reboot
arn:aws:automate:region:ec2:recover
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
Autoscaling action:
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function:
arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function:
arn:aws:lambda:region:account-id:function:function-name:alias-name
SNS notification action:
arn:aws:sns:region:account-id:sns-topic-name
SSM integration actions:
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
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:
EC2 actions:
arn:aws:automate:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:reboot
arn:aws:automate:region:ec2:recover
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
Autoscaling action:
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function:
arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function:
arn:aws:lambda:region:account-id:function:function-name:alias-name
SNS notification action:
arn:aws:sns:region:account-id:sns-topic-name
SSM integration actions:
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
Start a Amazon Q Developer operational investigation
arn:aws:aiops:region:account-id:investigation-group:ingestigation-group-id
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:
EC2 actions:
arn:aws:automate:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:reboot
arn:aws:automate:region:ec2:recover
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
Autoscaling action:
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function:
arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function:
arn:aws:lambda:region:account-id:function:function-name:alias-name
SNS notification action:
arn:aws:sns:region:account-id:sns-topic-name
SSM integration actions:
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
The name for the metric associated with the alarm. For each
put_metric_alarm 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 Namespace, Dimensions,
Period, Unit, Statistic, or ExtendedStatistic parameters.
Instead, you specify all this information in the Metrics array.
The namespace for the metric associated specified in MetricName.
The statistic for the metric specified in MetricName, other than
percentile. For percentile statistics, use ExtendedStatistic. When you
call put_metric_alarm and specify a
MetricName, you must specify either Statistic or
ExtendedStatistic, but not both.
The extended statistic for the metric specified in MetricName. When
you call put_metric_alarm and specify a
MetricName, you must specify either Statistic or ExtendedStatistic
but not both.
If you specify ExtendedStatistic, the following are valid values:
p90
tm90
tc90
ts90
wm90
IQM
PR(n:m) where n and m are values of the metric
TC(X%:X%) where X is between 10 and 90 inclusive.
TM(X%:X%) where X is between 10 and 90 inclusive.
TS(X%:X%) where X is between 10 and 90 inclusive.
WM(X%:X%) where X is between 10 and 90 inclusive.
For more information about these extended statistics, see CloudWatch statistics definitions.
The dimensions for the metric specified in MetricName.
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
put_metric_data 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.
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
are creating an alarm based on a metric math expression, you can specify
the unit for each metric (if needed) within the objects in the Metrics
array.
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 unpredictably.
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.
[required] 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.
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.
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.
[required] 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.
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
Alarms that evaluate metrics in the AWS/DynamoDB namespace always
ignore missing data even if you choose a different option for
TreatMissingData. When an AWS/DynamoDB metric has missing data,
alarms that evaluate that metric remain in their current state.
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
An array of MetricDataQuery structures that enable you to create an
alarm based on the result of a metric math expression. For each
put_metric_alarm 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 Namespace,
MetricName, Dimensions, Period, Unit, Statistic, or
ExtendedStatistic parameters of
put_metric_alarm in the same operation.
Instead, you retrieve the metrics you are using in your math expression
as part of the Metrics array.
A list of key-value pairs to associate with the alarm. You can associate
as many as 50 tags with an alarm. To be able to associate tags with the
alarm when you create the alarm, you must have the
cloudwatch:TagResource permission.
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 tag_resource or
untag_resource.
To use this field to set tags for an alarm when you create it, you must
be signed on with both the cloudwatch:PutMetricAlarm and
cloudwatch:TagResource permissions.
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.