Class DescribeActiveReceiptRuleSetCommandProtected

Returns the metadata and receipt rules for the receipt rule set that is currently active.

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

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

Example

Use a bare-bones client and the command you need to make an API call.

import { SESClient, DescribeActiveReceiptRuleSetCommand } from "@aws-sdk/client-ses"; // ES Modules import
// const { SESClient, DescribeActiveReceiptRuleSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import
const client = new SESClient(config);
const command = new DescribeActiveReceiptRuleSetCommand(input);
const response = await client.send(command);

Param

DescribeActiveReceiptRuleSetCommandInput

Returns

DescribeActiveReceiptRuleSetCommandOutput

See

• DescribeActiveReceiptRuleSetCommandInput for command's input shape.
• DescribeActiveReceiptRuleSetCommandOutput for command's response shape.
• config for SESClient's config shape.

Example

DescribeActiveReceiptRuleSet

// The following example returns the metadata and receipt rules for the receipt rule set that is currently active:
const input = {};
const command = new DescribeActiveReceiptRuleSetCommand(input);
const response = await client.send(command);
/* response ==
{
  "Metadata": {
    "CreatedTimestamp": "2016-07-15T16:25:59.607Z",
    "Name": "default-rule-set"
  },
  "Rules": [
    {
      "Actions": [
        {
          "S3Action": {
            "BucketName": "MyBucket",
            "ObjectKeyPrefix": "email"
          }
        }
      ],
      "Enabled": true,
      "Name": "MyRule",
      "ScanEnabled": true,
      "TlsPolicy": "Optional"
    }
  ]
}
*/
// example id: describeactivereceiptruleset-1469121611502