Put Metric Alarm
| cloudwatch_put_metric_alarm | R Documentation |
Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query¶
Description¶
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.
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:CreateServiceLinkedRolepermission for all alarms with EC2 actions -
The
iam:CreateServiceLinkedRolepermissions to create an alarm with Systems Manager OpsItem or response plan actions.
The first time you create an alarm in the Amazon Web Services 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.
Each put_metric_alarm action has a maximum uncompressed payload of 120
KB.
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.
Usage¶
cloudwatch_put_metric_alarm(AlarmName, AlarmDescription, ActionsEnabled,
OKActions, AlarmActions, InsufficientDataActions, MetricName, Namespace,
Statistic, ExtendedStatistic, Dimensions, Period, Unit,
EvaluationPeriods, DatapointsToAlarm, Threshold, ComparisonOperator,
TreatMissingData, EvaluateLowSampleCountPercentile, Metrics, Tags,
ThresholdMetricId)
Arguments¶
AlarmName |
[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 |
AlarmDescription |
The description for the alarm. |
ActionsEnabled |
Indicates whether actions should be executed during any changes
to the alarm state. The default is |
OKActions |
The actions to execute when this alarm transitions to an
EC2 actions:
Autoscaling action:
Lambda actions:
SNS notification action:
SSM integration actions:
|
AlarmActions |
The actions to execute when this alarm transitions to the
EC2 actions:
Autoscaling action:
Lambda actions:
SNS notification action:
SSM integration actions:
Start a Amazon Q Developer operational investigation
|
InsufficientDataActions |
The actions to execute when this alarm transitions to the
EC2 actions:
Autoscaling action:
Lambda actions:
SNS notification action:
SSM integration actions:
|
MetricName |
The name for the metric associated with the alarm. For each
If you are creating an alarm based on a math expression, you cannot
specify this parameter, or any of the |
Namespace |
The namespace for the metric associated specified in
|
Statistic |
The statistic for the metric specified in
|
ExtendedStatistic |
The extended statistic for the metric specified in
If you specify
For more information about these extended statistics, see CloudWatch statistics definitions. |
Dimensions |
The dimensions for the metric specified in
|
Period |
The length, in seconds, used each time the metric specified in
Be sure to specify 10 or 30 only for metrics that are stored by a
An alarm's total current evaluation period can be no longer than one
day, so |
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
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
If you don't specify 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 |
EvaluationPeriods |
[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 |
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. |
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. |
ComparisonOperator |
[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 |
TreatMissingData |
Sets how this alarm is to handle missing data points. If
Valid Values:
Alarms that evaluate metrics in the |
EvaluateLowSampleCountPercentile |
Used only for alarms based on percentiles. If you specify
Valid Values: |
Metrics |
An array of Each item in the One item in the If you use the |
Tags |
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
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 To use this field to set tags for an alarm when you create it, you
must be signed on with both the |
ThresholdMetricId |
If this is an alarm based on an anomaly detection model, make
this value match the ID of the 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. |
Value¶
An empty list.
Request syntax¶
svc$put_metric_alarm(
AlarmName = "string",
AlarmDescription = "string",
ActionsEnabled = TRUE|FALSE,
OKActions = list(
"string"
),
AlarmActions = list(
"string"
),
InsufficientDataActions = list(
"string"
),
MetricName = "string",
Namespace = "string",
Statistic = "SampleCount"|"Average"|"Sum"|"Minimum"|"Maximum",
ExtendedStatistic = "string",
Dimensions = list(
list(
Name = "string",
Value = "string"
)
),
Period = 123,
Unit = "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None",
EvaluationPeriods = 123,
DatapointsToAlarm = 123,
Threshold = 123.0,
ComparisonOperator = "GreaterThanOrEqualToThreshold"|"GreaterThanThreshold"|"LessThanThreshold"|"LessThanOrEqualToThreshold"|"LessThanLowerOrGreaterThanUpperThreshold"|"LessThanLowerThreshold"|"GreaterThanUpperThreshold",
TreatMissingData = "string",
EvaluateLowSampleCountPercentile = "string",
Metrics = list(
list(
Id = "string",
MetricStat = list(
Metric = list(
Namespace = "string",
MetricName = "string",
Dimensions = list(
list(
Name = "string",
Value = "string"
)
)
),
Period = 123,
Stat = "string",
Unit = "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"
),
Expression = "string",
Label = "string",
ReturnData = TRUE|FALSE,
Period = 123,
AccountId = "string"
)
),
Tags = list(
list(
Key = "string",
Value = "string"
)
),
ThresholdMetricId = "string"
)