describeReceiptRule method

Future<DescribeReceiptRuleResponse> describeReceiptRule({
  1. required String ruleName,
  2. required String ruleSetName,
})

Returns the details of the specified receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

May throw RuleDoesNotExistException. May throw RuleSetDoesNotExistException.

Parameter ruleName : The name of the receipt rule.

Parameter ruleSetName : The name of the receipt rule set that the receipt rule belongs to.

Implementation

Future<DescribeReceiptRuleResponse> describeReceiptRule({
  required String ruleName,
  required String ruleSetName,
}) async {
  ArgumentError.checkNotNull(ruleName, 'ruleName');
  ArgumentError.checkNotNull(ruleSetName, 'ruleSetName');
  final $request = <String, dynamic>{};
  $request['RuleName'] = ruleName;
  $request['RuleSetName'] = ruleSetName;
  final $result = await _protocol.send(
    $request,
    action: 'DescribeReceiptRule',
    version: '2010-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeReceiptRuleRequest'],
    shapes: shapes,
    resultWrapper: 'DescribeReceiptRuleResult',
  );
  return DescribeReceiptRuleResponse.fromXml($result);
}