The following example creates an alarm that notifies an SNS group when either of two specified metric alarms exceeds its threshold.
Sample Request
{ "AlarmDescription": "The host is experiencing problems",
"AlarmRule": "ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)", "AlarmName": "overall-health-alarm",
"AlarmActions": [
"arn:aws:sns:us-west-1:123456789012:my_sns_topic"
] }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
PutDashboard
Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 207).
DashboardBody
The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.
For more information about the syntax, see Dashboard Body Structure and Syntax.
Type: String Required: Yes DashboardName
The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and "_". This parameter is required.
Type: String Required: Yes
Response Elements
The following element is returned by the service.
DashboardValidationMessages.member.N
If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty.
If this result includes only warning messages, then the input was valid enough for the dashboard to be created or modified, but some elements of the dashboard might not render.
If this result includes error messages, the input was not valid and the operation failed.
Errors
Type: Array of DashboardValidationMessage (p. 128) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 209).
InternalServiceError
Request processing has failed due to some unknown error, exception, or failure.
HTTP Status Code: 500 InvalidParameterInput
Some part of the dashboard data is invalid.
HTTP Status Code: 400
Examples
Example
The following example creates a dashboard with just one text widget.
{"DashboardName":"Dashboard with only one text widget",
"DashboardBody":{
"widgets":[
{
"type":"text", "x":0,
"y":7, "width":3, "height":3, "properties":{
"markdown":"Hello world"
} } ] }}
Example
The following example modifies an existing dashboard to include one metric widget and one text widget.
{ "DashboardName": "Two-Widget Dashboard", "DashboardBody": {
"widgets": [ {
"type": "metric", "x": 0,
"y": 0, "width": 12, "height": 6,
"properties": {
The following example creates a dashboard with two metric widgets, side by side.
{
"DashboardName": "Two-metric-widget Dashboard", "DashboardBody": {
Examples
The following example creates a dashboard with one widget at the top that shows the DiskReadBytes metric for three EC2 instances on one graph, and a separate widget below that, with an alarm.
{ "DashboardName": "Dashboard with a three-metric graph and an alarm", "DashboardBody": {
"x": 0,
The following example creates a dashboard with one metric widget and one metric math widget.
{ "DashboardName":" One metric math widget and One metric widget", "DashboardBody":{
"widgets":[
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
PutInsightRule
Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 207).
RuleDefinition
The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 8192.
Pattern: [\x00-\x7F]+
Required: Yes RuleName
A unique name for the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\x20-\x7E]+
Required: Yes RuleState
The state of the rule. Valid values are ENABLED and DISABLED.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern: [\x20-\x7E]+
Required: No Tags.member.N
A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.
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 the resources that have certain tag values.
To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.
Errors
If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.
Type: Array of Tag (p. 166) objects Required: No
Errors
For information about the errors that are common to all actions, see Common Errors (p. 209).
InvalidParameterValue
The value of an input parameter is bad or out-of-range.
HTTP Status Code: 400 LimitExceeded
The operation exceeded one or more limits.
HTTP Status Code: 400 MissingParameter
An input parameter that is required is missing.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
PutMetricAlarm
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:CreateServiceLinkedRole for all alarms with EC2 actions
• The iam:CreateServiceLinkedRole to create an alarm with Systems Manager OpsItem actions.
The first time you create an alarm in the AWS Management Console, the AWS 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 AWS 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 cross-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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 207).
ActionsEnabled
Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
Type: Boolean Required: No
AlarmActions.member.N
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).
Request Parameters
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 Type: Array of strings
Array Members: Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No AlarmDescription
The description for the alarm.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No AlarmName
The name for the alarm. This name must be unique within the Region.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes 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.
Type: String
Valid Values: GreaterThanOrEqualToThreshold | GreaterThanThreshold
| LessThanThreshold | LessThanOrEqualToThreshold |
LessThanLowerOrGreaterThanUpperThreshold | LessThanLowerThreshold | GreaterThanUpperThreshold
Required: Yes 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.
Type: Integer
Valid Range: Minimum value of 1.
Required: No Dimensions.member.N
The dimensions for the metric specified in MetricName.
Type: Array of Dimension (p. 131) objects Array Members: Maximum number of 10 items.
Required: No
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 Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No 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.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes 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.
Type: String
Pattern: p(\d{1,2}(\.\d{0,2})?|100) Required: No
InsufficientDataActions.member.N
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
Request Parameters
| 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 Type: Array of strings
Array Members: Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No Metrics.member.N
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.
Type: Array of MetricDataQuery (p. 147) objects Required: No
Namespace
The namespace for the metric associated specified in MetricName.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: [^:].*
Required: No OKActions.member.N
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 Type: Array of strings
Array Members: Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No 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.
Type: Integer
Valid Range: Minimum value of 1.
Required: No 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.
Type: String
Valid Values: SampleCount | Average | Sum | Minimum | Maximum
Request Parameters
Required: No Tags.member.N
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.
Type: Array of Tag (p. 166) objects Required: No
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.
Type: Double Required: No 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No 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 Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No Unit
The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn
The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn