configuration_sets

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

Overview

Name	configuration_sets
Type	Resource
Id	aws.sesv2.configuration_sets

Fields

The following fields are returned by SELECT queries:

get_configuration_set

Name	Datatype	Description
archiving_options	object	Used to associate a configuration set with a MailManager archive.
configuration_set_name	string	The name of a configuration set. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
delivery_options	object	Used to associate a configuration set with a dedicated IP pool.
reputation_options	object	Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current Amazon Web Services Region.
sending_options	object	Used to enable or disable email sending for messages that use this configuration set in the current Amazon Web Services Region.
suppression_options	object	An object that contains information about the suppression list preferences for your account or for a specific tenant.
tags	array	An array of objects that define the tags (keys and values) that are associated with the configuration set.
tracking_options	object	An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them. These images and links include references to a domain operated by Amazon Web Services. You can optionally configure the Amazon SES to use a domain that you operate for these images and links.
vdm_options	object	An object that defines the VDM settings that apply to emails that you send using the configuration set.

list_configuration_sets

Name	Datatype	Description
configuration_set	string	An array that contains all of the configuration sets in your Amazon SES account in the current Amazon Web Services Region.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configuration_set	select	configuration_set_name, region		Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
list_configuration_sets	select	region	NextToken, PageSize	List all of the configuration sets associated with your account in the current region. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
create_configuration_set	insert	region, ConfigurationSetName		Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
put_configuration_set_archiving_options	replace	configuration_set_name, region		Associate the configuration set with a MailManager archive. When you send email using the SendEmail or SendBulkEmail operations the message as it will be given to the receiving SMTP server will be archived, along with the recipient information.
delete_configuration_set	delete	configuration_set_name, region		Delete an existing configuration set. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
put_configuration_set_delivery_options	exec	configuration_set_name, region		Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
put_configuration_set_reputation_options	exec	configuration_set_name, region		Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.
put_configuration_set_sending_options	exec	configuration_set_name, region		Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.
put_configuration_set_suppression_options	exec	configuration_set_name, region		Specify the suppression list preferences for a configuration set. You can also use this operation to specify a SuppressionScope to override the suppression scope of the tenant or account for emails sent using this configuration set.
put_configuration_set_tracking_options	exec	configuration_set_name, region		Specify a custom domain to use for open and click tracking elements in email that you send.
put_configuration_set_vdm_options	exec	configuration_set_name, region		Specify VDM preferences for email that you send using the configuration set. 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
configuration_set_name	string	The name of the configuration set.
region	string	AWS region (default: us-east-1)
NextToken	string	A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.
PageSize	integer	The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

SELECT examples

get_configuration_set

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

SELECT
archiving_options,
configuration_set_name,
delivery_options,
reputation_options,
sending_options,
suppression_options,
tags,
tracking_options,
vdm_options
FROM aws.sesv2.configuration_sets
WHERE configuration_set_name = '{{ configuration_set_name }}' -- required
AND region = '{{ region }}' -- required
;

list_configuration_sets

List all of the configuration sets associated with your account in the current region. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

SELECT
configuration_set
FROM aws.sesv2.configuration_sets
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND PageSize = '{{ PageSize }}'
;

INSERT examples

create_configuration_set

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

INSERT INTO aws.sesv2.configuration_sets (
ConfigurationSetName,
TrackingOptions,
DeliveryOptions,
ReputationOptions,
SendingOptions,
Tags,
SuppressionOptions,
VdmOptions,
ArchivingOptions,
region
)
SELECT 
'{{ ConfigurationSetName }}' /* required */,
'{{ TrackingOptions }}',
'{{ DeliveryOptions }}',
'{{ ReputationOptions }}',
'{{ SendingOptions }}',
'{{ Tags }}',
'{{ SuppressionOptions }}',
'{{ VdmOptions }}',
'{{ ArchivingOptions }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: configuration_sets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configuration_sets resource.
  - name: ConfigurationSetName
    value: "{{ ConfigurationSetName }}"
    description: |
      The name of a configuration set. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
  - name: TrackingOptions
    description: |
      An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them. These images and links include references to a domain operated by Amazon Web Services. You can optionally configure the Amazon SES to use a domain that you operate for these images and links.
    value:
      CustomRedirectDomain: "{{ CustomRedirectDomain }}"
      HttpsPolicy: "{{ HttpsPolicy }}"
  - name: DeliveryOptions
    description: |
      Used to associate a configuration set with a dedicated IP pool.
    value:
      TlsPolicy: "{{ TlsPolicy }}"
      SendingPoolName: "{{ SendingPoolName }}"
      MaxDeliverySeconds: {{ MaxDeliverySeconds }}
  - name: ReputationOptions
    description: |
      Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current Amazon Web Services Region.
    value:
      ReputationMetricsEnabled: {{ ReputationMetricsEnabled }}
      LastFreshStart: "{{ LastFreshStart }}"
  - name: SendingOptions
    description: |
      Used to enable or disable email sending for messages that use this configuration set in the current Amazon Web Services Region.
    value:
      SendingEnabled: {{ SendingEnabled }}
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: SuppressionOptions
    description: |
      An object that contains information about the suppression list preferences for your account or for a specific tenant.
    value:
      SuppressedReasons:
        - "{{ SuppressedReasons }}"
      SuppressionScope: "{{ SuppressionScope }}"
      ValidationOptions:
        ConditionThreshold:
          ConditionThresholdEnabled: "{{ ConditionThresholdEnabled }}"
          OverallConfidenceThreshold:
            ConfidenceVerdictThreshold: "{{ ConfidenceVerdictThreshold }}"
  - name: VdmOptions
    description: |
      An object that defines the VDM settings that apply to emails that you send using the configuration set.
    value:
      DashboardOptions:
        EngagementMetrics: "{{ EngagementMetrics }}"
      GuardianOptions:
        OptimizedSharedDelivery: "{{ OptimizedSharedDelivery }}"
  - name: ArchivingOptions
    description: |
      Used to associate a configuration set with a MailManager archive.
    value:
      ArchiveArn: "{{ ArchiveArn }}"

REPLACE examples

put_configuration_set_archiving_options

Associate the configuration set with a MailManager archive. When you send email using the SendEmail or SendBulkEmail operations the message as it will be given to the receiving SMTP server will be archived, along with the recipient information.

REPLACE aws.sesv2.configuration_sets
SET 
ArchiveArn = '{{ ArchiveArn }}'
WHERE 
configuration_set_name = '{{ configuration_set_name }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_configuration_set

Delete an existing configuration set. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

DELETE FROM aws.sesv2.configuration_sets
WHERE configuration_set_name = '{{ configuration_set_name }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

put_configuration_set_delivery_options

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.

EXEC aws.sesv2.configuration_sets.put_configuration_set_delivery_options 
@configuration_set_name='{{ configuration_set_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"TlsPolicy": "{{ TlsPolicy }}", 
"SendingPoolName": "{{ SendingPoolName }}", 
"MaxDeliverySeconds": {{ MaxDeliverySeconds }}
}'
;

put_configuration_set_reputation_options

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.

EXEC aws.sesv2.configuration_sets.put_configuration_set_reputation_options 
@configuration_set_name='{{ configuration_set_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"ReputationMetricsEnabled": {{ ReputationMetricsEnabled }}
}'
;

put_configuration_set_sending_options

Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.

EXEC aws.sesv2.configuration_sets.put_configuration_set_sending_options 
@configuration_set_name='{{ configuration_set_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"SendingEnabled": {{ SendingEnabled }}
}'
;

put_configuration_set_suppression_options

Specify the suppression list preferences for a configuration set. You can also use this operation to specify a SuppressionScope to override the suppression scope of the tenant or account for emails sent using this configuration set.

EXEC aws.sesv2.configuration_sets.put_configuration_set_suppression_options 
@configuration_set_name='{{ configuration_set_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"SuppressionScope": "{{ SuppressionScope }}", 
"SuppressedReasons": "{{ SuppressedReasons }}", 
"ValidationOptions": "{{ ValidationOptions }}"
}'
;

put_configuration_set_tracking_options

Specify a custom domain to use for open and click tracking elements in email that you send.

EXEC aws.sesv2.configuration_sets.put_configuration_set_tracking_options 
@configuration_set_name='{{ configuration_set_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"CustomRedirectDomain": "{{ CustomRedirectDomain }}", 
"HttpsPolicy": "{{ HttpsPolicy }}"
}'
;

put_configuration_set_vdm_options

Specify VDM preferences for email that you send using the configuration set. You can execute this operation no more than once per second.

EXEC aws.sesv2.configuration_sets.put_configuration_set_vdm_options 
@configuration_set_name='{{ configuration_set_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"VdmOptions": "{{ VdmOptions }}"
}'
;