configuration_sets

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

Overview

Name	configuration_sets
Type	Resource
Id	aws.ses.configuration_sets

Fields

The following fields are returned by SELECT queries:

describe_configuration_set

Name	Datatype	Description
cloud_watch_destination	string	An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
enabled	boolean	Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.
kinesis_firehose_destination	string	An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
matching_event_types	string	The type of email sending events to publish to the event destination. send - The call was successful and Amazon SES is attempting to deliver the email. reject - Amazon SES determined that the email contained a virus and rejected it. bounce - The recipient's mail server permanently rejected the email. This corresponds to a hard bounce. complaint - The recipient marked the email as spam. delivery - Amazon SES successfully delivered the email to the recipient's mail server. open - The recipient received the email and opened it in their email client. click - The recipient clicked one or more links in the email. renderingFailure - Amazon SES did not send the email because of a template rendering issue.
name	string	The name of the event destination. The name must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain 64 characters or fewer.
sns_destination	string	An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

list_configuration_sets

Name	Datatype	Description
name	string	The name of the configuration set. The name must meet the following requirements: Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain 64 characters or fewer.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_configuration_set	select	ConfigurationSetName, region	ConfigurationSetAttributeNames	Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
list_configuration_sets	select	region	NextToken, MaxItems	Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. You can execute this operation no more than once per second. This operation returns up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation also returns NextToken. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.
create_configuration_set_event_destination	insert	ConfigurationSetName, EventDestination, region		Creates a configuration set event destination. When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). An event destination is the Amazon Web Services service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
create_configuration_set_tracking_options	insert	ConfigurationSetName, TrackingOptions, region		Creates an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
create_configuration_set	insert	ConfigurationSet, region		Creates a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
update_configuration_set_event_destination	update	ConfigurationSetName, EventDestination, region		Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). You can execute this operation no more than once per second.
update_configuration_set_tracking_options	update	ConfigurationSetName, TrackingOptions, region		Modifies an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
update_configuration_set_reputation_metrics_enabled	update	ConfigurationSetName, region	Enabled	Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds. You can execute this operation no more than once per second.
put_configuration_set_delivery_options	replace	ConfigurationSetName, region	DeliveryOptions	Adds or updates the delivery options for a configuration set.
delete_configuration_set_event_destination	delete	ConfigurationSetName, EventDestinationName, region		Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
delete_configuration_set	delete	ConfigurationSetName, region		Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
delete_configuration_set_tracking_options	exec	ConfigurationSetName, region		Deletes an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. Deleting this kind of association results in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
update_configuration_set_sending_enabled	exec	ConfigurationSetName, region	Enabled	Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds. 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
ConfigurationSet	object	A data structure that contains the name of the configuration set.
ConfigurationSetName	string	The name of the configuration set to update.
EventDestination	object	The event destination object.
EventDestinationName	string	The name of the event destination to delete.
TrackingOptions	object
region	string	AWS region (default: us-east-1)
ConfigurationSetAttributeNames	array	A list of configuration set attributes to return.
DeliveryOptions	object	Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
Enabled	boolean	Describes whether email sending is enabled or disabled for the configuration set.
MaxItems	integer	The number of configuration sets to return.
NextToken	string	A token returned from a previous call to ListConfigurationSets to indicate the position of the configuration set in the configuration set list.

SELECT examples

describe_configuration_set

Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

SELECT
cloud_watch_destination,
enabled,
kinesis_firehose_destination,
matching_event_types,
name,
sns_destination
FROM aws.ses.configuration_sets
WHERE ConfigurationSetName = '{{ ConfigurationSetName }}' -- required
AND region = '{{ region }}' -- required
AND ConfigurationSetAttributeNames = '{{ ConfigurationSetAttributeNames }}'
;

list_configuration_sets

Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. You can execute this operation no more than once per second. This operation returns up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation also returns NextToken. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.

SELECT
name
FROM aws.ses.configuration_sets
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxItems = '{{ MaxItems }}'
;

INSERT examples

create_configuration_set_event_destination

Creates a configuration set event destination. When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). An event destination is the Amazon Web Services service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

INSERT INTO aws.ses.configuration_sets (
ConfigurationSetName,
EventDestination,
region
)
SELECT 
'{{ ConfigurationSetName }}',
'{{ EventDestination }}',
'{{ region }}'
;

create_configuration_set_tracking_options

Creates an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.

INSERT INTO aws.ses.configuration_sets (
ConfigurationSetName,
TrackingOptions,
region
)
SELECT 
'{{ ConfigurationSetName }}',
'{{ TrackingOptions }}',
'{{ region }}'
;

create_configuration_set

Creates a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

INSERT INTO aws.ses.configuration_sets (
ConfigurationSet,
region
)
SELECT 
'{{ ConfigurationSet }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: configuration_sets
props:
  - name: ConfigurationSetName
    value: "{{ ConfigurationSetName }}"
    description: Required parameter for the configuration_sets resource.
  - name: EventDestination
    value: "{{ EventDestination }}"
    description: Required parameter for the configuration_sets resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configuration_sets resource.
  - name: TrackingOptions
    value: "{{ TrackingOptions }}"
    description: Required parameter for the configuration_sets resource.
  - name: ConfigurationSet
    value: "{{ ConfigurationSet }}"
    description: Required parameter for the configuration_sets resource.

UPDATE examples

update_configuration_set_event_destination

Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). You can execute this operation no more than once per second.

UPDATE aws.ses.configuration_sets
SET 
-- No updatable properties
WHERE 
ConfigurationSetName = '{{ ConfigurationSetName }}' --required
AND EventDestination = '{{ EventDestination }}' --required
AND region = '{{ region }}' --required;

update_configuration_set_tracking_options

Modifies an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.

UPDATE aws.ses.configuration_sets
SET 
-- No updatable properties
WHERE 
ConfigurationSetName = '{{ ConfigurationSetName }}' --required
AND TrackingOptions = '{{ TrackingOptions }}' --required
AND region = '{{ region }}' --required;

update_configuration_set_reputation_metrics_enabled

Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds. You can execute this operation no more than once per second.

UPDATE aws.ses.configuration_sets
SET 
-- No updatable properties
WHERE 
ConfigurationSetName = '{{ ConfigurationSetName }}' --required
AND region = '{{ region }}' --required
AND Enabled = {{ Enabled}};

REPLACE examples

put_configuration_set_delivery_options

Adds or updates the delivery options for a configuration set.

REPLACE aws.ses.configuration_sets
SET 
-- No updatable properties
WHERE 
ConfigurationSetName = '{{ ConfigurationSetName }}' --required
AND region = '{{ region }}' --required
AND DeliveryOptions = '{{ DeliveryOptions}}';

DELETE examples

delete_configuration_set_event_destination

Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

DELETE FROM aws.ses.configuration_sets
WHERE ConfigurationSetName = '{{ ConfigurationSetName }}' --required
AND EventDestinationName = '{{ EventDestinationName }}' --required
AND region = '{{ region }}' --required
;

delete_configuration_set

Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

DELETE FROM aws.ses.configuration_sets
WHERE ConfigurationSetName = '{{ ConfigurationSetName }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

delete_configuration_set_tracking_options

Deletes an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. Deleting this kind of association results in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.

EXEC aws.ses.configuration_sets.delete_configuration_set_tracking_options 
@ConfigurationSetName='{{ ConfigurationSetName }}' --required, 
@region='{{ region }}' --required
;

update_configuration_set_sending_enabled

Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds. You can execute this operation no more than once per second.

EXEC aws.ses.configuration_sets.update_configuration_set_sending_enabled 
@ConfigurationSetName='{{ ConfigurationSetName }}' --required, 
@region='{{ region }}' --required, 
@Enabled={{ Enabled }}
;