active_receipt_rule_sets

Creates, updates, deletes, gets or lists an active_receipt_rule_sets resource.

Overview

Name	active_receipt_rule_sets
Type	Resource
Id	aws.ses.active_receipt_rule_sets

Fields

The following fields are returned by SELECT queries:

describe_active_receipt_rule_set

Name	Datatype	Description
actions	string	An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
enabled	boolean	If true, the receipt rule is active. The default value is false.
name	string	The name of the receipt rule. The name must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.). Start and end with a letter or number. Contain 64 characters or fewer.
recipients	string	The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
scan_enabled	boolean	If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
tls_policy	string	Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_active_receipt_rule_set	select	region		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.
set_active_receipt_rule_set	update	region	RuleSetName	Sets the specified receipt rule set as the active receipt rule set. To disable your email-receiving through Amazon SES completely, you can call this operation with RuleSetName set to null. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
RuleSetName	string	The name of the receipt rule set to make active. Setting this value to null disables all email receiving.

SELECT examples

describe_active_receipt_rule_set

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.

SELECT
actions,
enabled,
name,
recipients,
scan_enabled,
tls_policy
FROM aws.ses.active_receipt_rule_sets
WHERE region = '{{ region }}' -- required
;

UPDATE examples

set_active_receipt_rule_set

Sets the specified receipt rule set as the active receipt rule set. To disable your email-receiving through Amazon SES completely, you can call this operation with RuleSetName set to null. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

UPDATE aws.ses.active_receipt_rule_sets
SET 
-- No updatable properties
WHERE 
region = '{{ region }}' --required
AND RuleSetName = '{{ RuleSetName}}';