paws.management (version 0.1.0)

cloudwatch_set_alarm_state: Temporarily sets the state of an alarm for testing purposes

Description

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 SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

Usage

cloudwatch_set_alarm_state(AlarmName, StateValue, StateReason,
  StateReasonData)

Arguments

AlarmName

[required] The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.

StateValue

[required] The value of the state.

StateReason

[required] The reason that this alarm is set to this specific state, in text format.

StateReasonData

The reason that this alarm is set to this specific state, in JSON format.

Request syntax

svc$set_alarm_state(
  AlarmName = "string",
  StateValue = "OK"|"ALARM"|"INSUFFICIENT_DATA",
  StateReason = "string",
  StateReasonData = "string"
)