AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For PCL and Unity this operation is only available in asynchronous form. Please refer to DescribeReceiptRuleAsync.

Namespace: Amazon.SimpleEmail
Assembly: AWSSDK.SimpleEmail.dll
Version: 3.x.y.z

Syntax

C#
public virtual DescribeReceiptRuleResponse DescribeReceiptRule(
         DescribeReceiptRuleRequest request
)
Parameters
request
Type: Amazon.SimpleEmail.Model.DescribeReceiptRuleRequest

Container for the necessary parameters to execute the DescribeReceiptRule service method.

Return Value
The response from the DescribeReceiptRule service method, as returned by SimpleEmailService.

Exceptions

ExceptionCondition
RuleDoesNotExistException Indicates that the provided receipt rule does not exist.
RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.

Examples

The following example returns the details of a receipt rule:

DescribeReceiptRule


var response = client.DescribeReceiptRule(new DescribeReceiptRuleRequest 
{
    RuleName = "MyRule",
    RuleSetName = "MyRuleSet"
});

ReceiptRule rule = response.Rule;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also