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.

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to TestAlarmAsync.

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

Syntax

C#
public virtual TestAlarmResponse TestAlarm(
         TestAlarmRequest request
)

Parameters

request
Type: Amazon.Lightsail.Model.TestAlarmRequest

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

Return Value


The response from the TestAlarm service method, as returned by Lightsail.

Exceptions

ExceptionCondition
AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException Lightsail throws this exception when it cannot find a resource.
OperationFailureException Lightsail throws this exception when an operation fails to execute.
ServiceException A general service exception.
UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.

Version Information

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

See Also