identities

Creates, updates, deletes, gets or lists an identities resource.

Overview

Name	identities
Type	Resource
Id	aws.ses.identities

Fields

The following fields are returned by SELECT queries:

list_identities

Name	Datatype	Description
identity	string	A list of identities.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_identities	select	region	IdentityType, NextToken, MaxItems	Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status. You can execute this operation no more than once per second. It's recommended that for successive pagination calls of this API, you continue to the use the same parameter/value pairs as used in the original call, e.g., if you used IdentityType=Domain in the the original call and received a NextToken in the response, you should continue providing the IdentityType=Domain parameter for further NextToken calls; however, if you didn't provide the IdentityType parameter in the original call, then continue to not provide it for successive pagination calls. Using this protocol will ensure consistent results.
set_identity_dkim_enabled	update	DkimEnabled, region	Identity	Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address. For email addresses (for example, user@example.com), you can only enable DKIM signing if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM. You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete. You can execute this operation no more than once per second. For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
set_identity_feedback_forwarding_enabled	update	ForwardingEnabled, region	Identity	Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
set_identity_headers_in_notifications_enabled	update	NotificationType, region	Identity, Enabled	Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
set_identity_mail_from_domain	update	region	Identity, MailFromDomain, BehaviorOnMXFailure	Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
delete_identity	delete	region	Identity	Deletes the specified identity (an email address or a domain) from the list of verified identities. You can execute this operation no more than once per second.
set_identity_notification_topic	exec	NotificationType, region	Identity, SnsTopic	Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify. You can execute this operation no more than once per second. For more information about feedback notification, see the Amazon SES Developer Guide.

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
DkimEnabled	boolean	Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.
ForwardingEnabled	boolean	Sets whether Amazon SES forwards bounce and complaint notifications as email. true specifies that Amazon SES forwards bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES publishes bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types.
NotificationType	string	The type of notifications that are published to the specified Amazon SNS topic.
region	string	AWS region (default: us-east-1)
BehaviorOnMXFailure	string	The action for Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES returns a MailFromDomainNotVerified error and not send the email. The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states.
Enabled	boolean	Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES includes headers in notifications, and a value of false specifies that Amazon SES does not include headers in notifications. This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.
Identity	string	The identity (email address or domain) for the Amazon SNS topic. You can only specify a verified identity for this parameter. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
IdentityType	string	The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities are listed.
MailFromDomain	string	The custom MAIL FROM domain for the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity.
MaxItems	integer	The maximum number of identities per page. Possible values are 1-1000 inclusive.
NextToken	string	The token to use for pagination.
SnsTopic	string	The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.

SELECT examples

list_identities

Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status. You can execute this operation no more than once per second. It's recommended that for successive pagination calls of this API, you continue to the use the same parameter/value pairs as used in the original call, e.g., if you used IdentityType=Domain in the the original call and received a NextToken in the response, you should continue providing the IdentityType=Domain parameter for further NextToken calls; however, if you didn't provide the IdentityType parameter in the original call, then continue to not provide it for successive pagination calls. Using this protocol will ensure consistent results.

SELECT
identity
FROM aws.ses.identities
WHERE region = '{{ region }}' -- required
AND IdentityType = '{{ IdentityType }}'
AND NextToken = '{{ NextToken }}'
AND MaxItems = '{{ MaxItems }}'
;

UPDATE examples

set_identity_dkim_enabled

Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address. For email addresses (for example, user@example.com), you can only enable DKIM signing if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM. You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete. You can execute this operation no more than once per second. For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

UPDATE aws.ses.identities
SET 
-- No updatable properties
WHERE 
DkimEnabled = '{{ DkimEnabled }}' --required
AND region = '{{ region }}' --required
AND Identity = '{{ Identity}}';

set_identity_feedback_forwarding_enabled

Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

UPDATE aws.ses.identities
SET 
-- No updatable properties
WHERE 
ForwardingEnabled = '{{ ForwardingEnabled }}' --required
AND region = '{{ region }}' --required
AND Identity = '{{ Identity}}';

set_identity_headers_in_notifications_enabled

Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

UPDATE aws.ses.identities
SET 
-- No updatable properties
WHERE 
NotificationType = '{{ NotificationType }}' --required
AND region = '{{ region }}' --required
AND Identity = '{{ Identity}}'
AND Enabled = {{ Enabled}};

set_identity_mail_from_domain

Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.

UPDATE aws.ses.identities
SET 
-- No updatable properties
WHERE 
region = '{{ region }}' --required
AND Identity = '{{ Identity}}'
AND MailFromDomain = '{{ MailFromDomain}}'
AND BehaviorOnMXFailure = '{{ BehaviorOnMXFailure}}';

DELETE examples

delete_identity

Deletes the specified identity (an email address or a domain) from the list of verified identities. You can execute this operation no more than once per second.

DELETE FROM aws.ses.identities
WHERE region = '{{ region }}' --required
AND Identity = '{{ Identity }}'
;

Lifecycle Methods

set_identity_notification_topic

Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify. You can execute this operation no more than once per second. For more information about feedback notification, see the Amazon SES Developer Guide.

EXEC aws.ses.identities.set_identity_notification_topic 
@NotificationType='{{ NotificationType }}' --required, 
@region='{{ region }}' --required, 
@Identity='{{ Identity }}', 
@SnsTopic='{{ SnsTopic }}'
;