describeAlarm method

Future<DescribeAlarmResponse> describeAlarm({
  1. required String alarmModelName,
  2. String? keyValue,
})

Retrieves information about an alarm.

May throw InternalFailureException. May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ServiceUnavailableException. May throw ThrottlingException.

Parameter alarmModelName : The name of the alarm model.

Parameter keyValue : The value of the key used as a filter to select only the alarms associated with the key.

Implementation

Future<DescribeAlarmResponse> describeAlarm({
  required String alarmModelName,
  String? keyValue,
}) async {
  final $query = <String, List<String>>{
    if (keyValue != null) 'keyValue': [keyValue],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/alarms/${Uri.encodeComponent(alarmModelName)}/keyValues',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return DescribeAlarmResponse.fromJson(response);
}