Menu
Amazon Simple Email Service
API Reference (API Version 2010-12-01)

DescribeReceiptRule

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

RuleName

The name of the receipt rule.

Type: String

Required: Yes

RuleSetName

The name of the receipt rule set that the receipt rule belongs to.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

Rule

A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.

Type: ReceiptRule object

Errors

For information about the errors that are common to all actions, see Common Errors.

RuleDoesNotExist

Indicates that the provided receipt rule does not exist.

HTTP Status Code: 400

RuleSetDoesNotExist

Indicates that the provided receipt rule set does not exist.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: