receipt_rules

Creates, updates, deletes, gets or lists a receipt_rules resource.

Overview

Name	receipt_rules
Type	Resource
Id	aws.ses.receipt_rules

Fields

The following fields are returned by SELECT queries:

describe_receipt_rule

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_receipt_rule	select	RuleSetName, RuleName, 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.
create_receipt_rule	insert	RuleSetName, Rule, region	After	Creates a 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.
set_receipt_rule_position	update	RuleSetName, RuleName, region	After	Sets the position of the specified receipt rule in the receipt rule set. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
update_receipt_rule	update	RuleSetName, Rule, region		Updates a receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
delete_receipt_rule	delete	RuleSetName, RuleName, region		Deletes the specified receipt rule. For information about managing receipt rules, 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
Rule	object	A data structure that contains the updated receipt rule information.
RuleName	string	The name of the receipt rule to delete.
RuleSetName	string	The name of the receipt rule set that contains the receipt rule to delete.
region	string	AWS region (default: us-east-1)
After	string	The name of the receipt rule after which to place the specified receipt rule.

SELECT examples

describe_receipt_rule

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.

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

INSERT examples

create_receipt_rule

Creates a 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.

INSERT INTO aws.ses.receipt_rules (
RuleSetName,
Rule,
region,
After
)
SELECT 
'{{ RuleSetName }}',
'{{ Rule }}',
'{{ region }}',
'{{ After }}'
;

Manifest

# Description fields are for documentation purposes
- name: receipt_rules
props:
  - name: RuleSetName
    value: "{{ RuleSetName }}"
    description: Required parameter for the receipt_rules resource.
  - name: Rule
    value: "{{ Rule }}"
    description: Required parameter for the receipt_rules resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the receipt_rules resource.
  - name: After
    value: "{{ After }}"
    description: The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.
    description: The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.

UPDATE examples

set_receipt_rule_position

Sets the position of the specified receipt rule in the receipt rule set. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

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

update_receipt_rule

Updates a receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

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

DELETE examples

delete_receipt_rule

Deletes the specified receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

DELETE FROM aws.ses.receipt_rules
WHERE RuleSetName = '{{ RuleSetName }}' --required
AND RuleName = '{{ RuleName }}' --required
AND region = '{{ region }}' --required
;