Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions,
see Getting Started with Amazon Web Services in China
(PDF).
Describe CloudWatch alarms using an Amazon SDK
The following code examples show how to describe Amazon CloudWatch alarms.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in
context in the following code examples:
- .NET
-
- Amazon SDK for .NET
-
/// <summary>
/// Describe the current alarms, optionally filtered by state.
/// </summary>
/// <param name="stateValue">Optional filter for alarm state.</param>
/// <returns>The list of alarm data.</returns>
public async Task<List<MetricAlarm>> DescribeAlarms(StateValue? stateValue = null)
{
List<MetricAlarm> alarms = new List<MetricAlarm>();
var paginatedDescribeAlarms = _amazonCloudWatch.Paginators.DescribeAlarms(
new DescribeAlarmsRequest()
{
StateValue = stateValue
});
await foreach (var data in paginatedDescribeAlarms.MetricAlarms)
{
alarms.Add(data);
}
return alarms;
}
- Java
-
- SDK for Java 2.x
-
public static void describeAlarms(CloudWatchClient cw) {
try {
List<AlarmType> typeList = new ArrayList<>();
typeList.add(AlarmType.METRIC_ALARM);
DescribeAlarmsRequest alarmsRequest = DescribeAlarmsRequest.builder()
.alarmTypes(typeList)
.maxRecords(10)
.build();
DescribeAlarmsResponse response = cw.describeAlarms(alarmsRequest);
List<MetricAlarm> alarmList = response.metricAlarms();
for (MetricAlarm alarm: alarmList) {
System.out.println("Alarm name: " + alarm.alarmName());
System.out.println("Alarm description: " + alarm.alarmDescription());
}
} catch (CloudWatchException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
- Kotlin
-
- SDK for Kotlin
-
This is prerelease documentation for a feature in preview release. It is subject to change.
suspend fun describeAlarms() {
val typeList = ArrayList<AlarmType>()
typeList.add(AlarmType.MetricAlarm)
val alarmsRequest = DescribeAlarmsRequest {
alarmTypes = typeList
maxRecords = 10
}
CloudWatchClient { region = "us-east-1" }.use { cwClient ->
val response = cwClient.describeAlarms(alarmsRequest)
response.metricAlarms?.forEach { alarm ->
println("Alarm name: ${alarm.alarmName}")
println("Alarm description: ${alarm.alarmDescription}")
}
}
}
- SAP ABAP
-
- SDK for SAP ABAP
-
TRY.
oo_result = lo_cwt->describealarms( " oo_result is returned for testing purposes. "
it_alarmnames = it_alarm_names
).
MESSAGE 'Alarms retrieved.' TYPE 'I'.
CATCH /aws1/cx_rt_service_generic INTO DATA(lo_exception).
DATA(lv_error) = |"{ lo_exception->av_err_code }" - { lo_exception->av_err_msg }|.
MESSAGE lv_error TYPE 'E'.
ENDTRY.
For a complete list of Amazon SDK developer guides and code examples, see
Using CloudWatch with an Amazon SDK.
This topic also includes information about getting started and details about previous SDK versions.