describeRules method

Future<DescribeRulesOutput> describeRules({ String? listenerArn, String? marker, int? pageSize, List<String>? ruleArns, })

Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.

May throw ListenerNotFoundException. May throw RuleNotFoundException. May throw UnsupportedProtocolException.

Parameter listenerArn : The Amazon Resource Name (ARN) of the listener.

Parameter marker : The marker for the next set of results. (You received this marker from a previous call.)

Parameter pageSize : The maximum number of results to return with this call.

Parameter ruleArns : The Amazon Resource Names (ARN) of the rules.

Implementation

Future<DescribeRulesOutput> describeRules({
  String? listenerArn,
  String? marker,
  int? pageSize,
  List<String>? ruleArns,
}) async {
  _s.validateNumRange(
    'pageSize',
    pageSize,
    1,
    400,
  );
  final $request = <String, dynamic>{};
  listenerArn?.also((arg) => $request['ListenerArn'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  pageSize?.also((arg) => $request['PageSize'] = arg);
  ruleArns?.also((arg) => $request['RuleArns'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeRules',
    version: '2015-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeRulesInput'],
    shapes: shapes,
    resultWrapper: 'DescribeRulesResult',
  );
  return DescribeRulesOutput.fromXml($result);
}