receipt_rule_sets

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

Overview

Name	receipt_rule_sets
Type	Resource
Id	aws.ses.receipt_rule_sets

Fields

The following fields are returned by SELECT queries:

describe_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.

list_receipt_rule_sets

Name	Datatype	Description
created_timestamp	string	The date and time the receipt rule set was created.
name	string	The name of the receipt rule set. The name must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Start and end with a letter or number. Contain 64 characters or fewer.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_receipt_rule_set	select	RuleSetName, region		Returns the details of the specified receipt rule set. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
list_receipt_rule_sets	select	region	NextToken	Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region. If there are additional receipt rule sets to be retrieved, you receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
create_receipt_rule_set	insert	RuleSetName, region		Creates an empty receipt rule set. 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.
delete_receipt_rule_set	delete	RuleSetName, region		Deletes the specified receipt rule set and all of the receipt rules it contains. The currently active rule set cannot be deleted. 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
RuleSetName	string	The name of the receipt rule set to delete.
region	string	AWS region (default: us-east-1)
NextToken	string	A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt rule set list.

SELECT examples

describe_receipt_rule_set

Returns the details of the specified receipt rule set. For information about managing 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.receipt_rule_sets
WHERE RuleSetName = '{{ RuleSetName }}' -- required
AND region = '{{ region }}' -- required
;

list_receipt_rule_sets

Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region. If there are additional receipt rule sets to be retrieved, you receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

SELECT
created_timestamp,
name
FROM aws.ses.receipt_rule_sets
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_receipt_rule_set

Creates an empty receipt rule set. 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.

INSERT INTO aws.ses.receipt_rule_sets (
RuleSetName,
region
)
SELECT 
'{{ RuleSetName }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: receipt_rule_sets
props:
  - name: RuleSetName
    value: "{{ RuleSetName }}"
    description: Required parameter for the receipt_rule_sets resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the receipt_rule_sets resource.

DELETE examples

delete_receipt_rule_set

Deletes the specified receipt rule set and all of the receipt rules it contains. The currently active rule set cannot be deleted. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

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