receipt_filters

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

Overview

Name	receipt_filters
Type	Resource
Id	aws.ses.receipt_filters

Fields

The following fields are returned by SELECT queries:

list_receipt_filters

Name	Datatype	Description
ip_filter	string	A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
name	string	The name of the IP address filter. 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
list_receipt_filters	select	region		Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
create_receipt_filter	insert	Filter, region		Creates a new IP address filter. For information about setting up IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
delete_receipt_filter	delete	FilterName, region		Deletes the specified IP address filter. For information about managing IP address filters, 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
Filter	object	A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.
FilterName	string	The name of the IP address filter to delete.
region	string	AWS region (default: us-east-1)

SELECT examples

list_receipt_filters

Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

SELECT
ip_filter,
name
FROM aws.ses.receipt_filters
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_receipt_filter

Creates a new IP address filter. For information about setting up IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

INSERT INTO aws.ses.receipt_filters (
Filter,
region
)
SELECT 
'{{ Filter }}',
'{{ region }}'
;

Manifest

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

DELETE examples

delete_receipt_filter

Deletes the specified IP address filter. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

DELETE FROM aws.ses.receipt_filters
WHERE FilterName = '{{ FilterName }}' --required
AND region = '{{ region }}' --required
;