AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to SetAlarmStateAsync.

Namespace: Amazon.CloudWatch
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z

Syntax

C#
public abstract SetAlarmStateResponse SetAlarmState(
         SetAlarmStateRequest request
)
Parameters
request
Type: Amazon.CloudWatch.Model.SetAlarmStateRequest

Container for the necessary parameters to execute the SetAlarmState service method.

Return Value
The response from the SetAlarmState service method, as returned by CloudWatch.

Exceptions

ExceptionCondition
InvalidFormatException Data was not syntactically valid JSON.
ResourceNotFoundException The named resource does not exist.

Examples

This example shows how to temporarily set an alarm's state.

Set alarm state example

var client = new AmazonCloudWatchClient();

var request = new SetAlarmStateRequest
{
  AlarmName = "Offline Instances",
  StateReason = "Too many instances are offline.",
  StateValue = StateValue.ALARM
};

client.SetAlarmState(request);
      

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also