Menu
Amazon CloudWatch
API Reference (API Version 2010-08-01)

MetricAlarm

The MetricAlarm data type represents an alarm. You can use PutMetricAlarm to create or update an alarm.

Contents

ActionsEnabled

Indicates whether 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 ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Type: array of Strings

Array Members: Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

AlarmArn

The Amazon Resource Name (ARN) of the alarm.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: No

AlarmConfigurationUpdatedTimestamp

The time stamp of the last update to the alarm configuration.

Type: Timestamp

Required: No

AlarmDescription

The description for the alarm.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Required: No

AlarmName

The name of the alarm.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

ComparisonOperator

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

Type: String

Valid Values: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold

Required: No

Dimensions.member.N

The list of dimensions associated with the alarm's associated metric.

Type: array of Dimension objects

Array Members: Maximum number of 10 items.

Required: No

EvaluationPeriods

The number of periods over which data is compared to the specified threshold.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

InsufficientDataActions.member.N

The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Important

The current WSDL lists this attribute as UnknownActions.

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 of the alarm's metric.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

Namespace

The namespace of alarm's associated metric.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^:].*

Required: No

OKActions.member.N

The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

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 period in seconds over which the statistic is applied.

Type: Integer

Valid Range: Minimum value of 60.

Required: No

StateReason

A human-readable explanation for the alarm's state.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1023.

Required: No

StateReasonData

An explanation for the alarm's state in machine-readable JSON format

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4000.

Required: No

StateUpdatedTimestamp

The time stamp of the last update to the alarm's state.

Type: Timestamp

Required: No

StateValue

The state value for the alarm.

Type: String

Valid Values: OK | ALARM | INSUFFICIENT_DATA

Required: No

Statistic

The statistic to apply to the alarm's associated metric.

Type: String

Valid Values: SampleCount | Average | Sum | Minimum | Maximum

Required: No

Threshold

The value against which the specified statistic is compared.

Type: Double

Required: No

Unit

The unit of 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 | None

Required: No