describeAlarmContributors method

Future<DescribeAlarmContributorsOutput> describeAlarmContributors({
  1. required String alarmName,
  2. String? nextToken,
})

Returns the information of the current alarm contributors that are in ALARM state. This operation returns details about the individual time series that contribute to the alarm's state.

May throw InvalidNextToken. May throw ResourceNotFoundException.

Parameter alarmName : The name of the alarm for which to retrieve contributor information.

Parameter nextToken : The token returned by a previous call to indicate that there is more data available.

Implementation

Future<DescribeAlarmContributorsOutput> describeAlarmContributors({
  required String alarmName,
  String? nextToken,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'GraniteServiceVersion20100801.DescribeAlarmContributors'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'AlarmName': alarmName,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return DescribeAlarmContributorsOutput.fromJson(jsonResponse.body);
}