Temporarily sets the state of an alarm for testing purposes. When the updated
state differs from the previous value, the action configured for
the appropriate state is invoked. For example, if your alarm is configured to send an
Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to
ALARM sends an Amazon SNS message. The alarm
returns to its actual state (often within seconds). Because the alarm state change
happens very quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through
For information about the parameters that are common to all actions, see Common Parameters.
The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.
Length Constraints: Minimum length of 1. Maximum length of 255.
The reason that this alarm is set to this specific state, in text format.
Length Constraints: Minimum length of 0. Maximum length of 1023.
The reason that this alarm is set to this specific state, in JSON format.
Length Constraints: Minimum length of 0. Maximum length of 4000.
The value of the state.
OK | ALARM | INSUFFICIENT_DATA
For information about the errors that are common to all actions, see Common Errors.
For more information about using this API in one of the language-specific AWS SDKs, see the following: