| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
PutMetricAlarm
Description
Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service 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
StateValue is set appropriately. Any actions associated
with the StateValue is then executed.
Note
When updating an existing alarm, its StateValue
is left unchanged.
Request Parameters
For information about the common parameters that all actions use, see Common Parameters.
- ActionsEnabled
Indicates whether or not actions should be executed during any changes to the alarm's state.
Type: Boolean
Required: No
- AlarmActions.member.N
The list of actions to execute when this alarm transitions into an
ALARMstate from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.Type: String list
Length constraints: Minimum of 0 item(s) in the list. Maximum of 5 item(s) in the list.
Required: No
- AlarmDescription
The description for the alarm.
Type: String
Length constraints: Minimum length of 0. Maximum length of 255.
Required: No
- AlarmName
The descriptive name for the alarm. This name must be unique within the user's AWS account
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- ComparisonOperator
The arithmetic operation to use when comparing the specified
StatisticandThreshold. The specifiedStatisticvalue is used as the first operand.Type: String
Valid Values:
GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThresholdRequired: Yes
- Dimensions.member.N
The dimensions for the alarm's associated metric.
Type: Dimension list
Length constraints: Minimum of 0 item(s) in the list. Maximum of 10 item(s) in the list.
Required: No
- EvaluationPeriods
The number of periods over which data is compared to the specified threshold.
Type: Integer
Required: Yes
- InsufficientDataActions.member.N
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATAstate from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.Type: String list
Length constraints: Minimum of 0 item(s) in the list. Maximum of 5 item(s) in the list.
Required: No
- MetricName
The name for the alarm's associated metric.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- Namespace
The namespace for the alarm's associated metric.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- OKActions.member.N
The list of actions to execute when this alarm transitions into an
OKstate from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.Type: String list
Length constraints: Minimum of 0 item(s) in the list. Maximum of 5 item(s) in the list.
Required: No
- Period
The period in seconds over which the specified statistic is applied.
Type: Integer
Required: Yes
- Statistic
The statistic to apply to the alarm's associated metric.
Type: String
Valid Values:
SampleCount | Average | Sum | Minimum | MaximumRequired: Yes
- Threshold
The value against which the specified statistic is compared.
Type: Double
Required: Yes
- Unit
The unit for the alarm's associated metric.
Type: String
Valid Values:
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 | NoneRequired: No
Errors
For information about the errors that are common to all actions, see Common Errors.
- LimitExceeded
The quota for alarms for this customer has already been reached.
HTTP Status Code: 400
