email_identities

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

Overview

Name	email_identities
Type	Resource
Id	aws.pinpoint_email.email_identities

Fields

The following fields are returned by SELECT queries:

get_email_identity

Name	Datatype	Description
dkim_attributes	object	An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.
feedback_forwarding_status	boolean	The feedback forwarding configuration for the identity. If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
identity_type	string	The email identity type. (EMAIL_ADDRESS, DOMAIN, MANAGED_DOMAIN)
mail_from_attributes	object	An object that contains information about the Mail-From attributes for the email identity.
tags	array	An array of objects that define the tags (keys and values) that are associated with the email identity.
verified_for_sending_status	boolean	Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

list_email_identities

Name	Datatype	Description
identity_name	string	The address or domain of the identity.
identity_type	string	The email identity type. The identity type can be one of the following: EMAIL_ADDRESS – The identity is an email address. DOMAIN – The identity is a domain. MANAGED_DOMAIN – The identity is a domain that is managed by AWS. (EMAIL_ADDRESS, DOMAIN, MANAGED_DOMAIN)
sending_enabled	boolean	Indicates whether or not you can send email from the identity. In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon Pinpoint to send email from that identity.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_email_identity	select	email_identity, region		Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
list_email_identities	select	region	NextToken, PageSize	Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.
create_email_identity	insert	region, EmailIdentity		Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address. When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.
put_email_identity_dkim_attributes	replace	email_identity, region		Used to enable or disable DKIM authentication for an email identity.
delete_email_identity	delete	email_identity, region		Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.
put_email_identity_feedback_attributes	exec	email_identity, region		Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event. When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
put_email_identity_mail_from_attributes	exec	email_identity, region		Used to enable or disable the custom Mail-From domain configuration for an email identity.

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
email_identity	string	The verified email identity that you want to set up the custom MAIL FROM domain for.
region	string	AWS region (default: us-east-1)
NextToken	string	A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.
PageSize	integer	The number of results to show in a single call to ListEmailIdentities. 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. The value you specify has to be at least 0, and can be no more than 1000.

SELECT examples

get_email_identity

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

SELECT
dkim_attributes,
feedback_forwarding_status,
identity_type,
mail_from_attributes,
tags,
verified_for_sending_status
FROM aws.pinpoint_email.email_identities
WHERE email_identity = '{{ email_identity }}' -- required
AND region = '{{ region }}' -- required
;

list_email_identities

Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.

SELECT
identity_name,
identity_type,
sending_enabled
FROM aws.pinpoint_email.email_identities
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND PageSize = '{{ PageSize }}'
;

INSERT examples

create_email_identity

Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address. When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

INSERT INTO aws.pinpoint_email.email_identities (
EmailIdentity,
Tags,
region
)
SELECT 
'{{ EmailIdentity }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
dkim_attributes,
identity_type,
verified_for_sending_status
;

Manifest

# Description fields are for documentation purposes
- name: email_identities
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the email_identities resource.
  - name: EmailIdentity
    value: "{{ EmailIdentity }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

REPLACE examples

put_email_identity_dkim_attributes

Used to enable or disable DKIM authentication for an email identity.

REPLACE aws.pinpoint_email.email_identities
SET 
SigningEnabled = {{ SigningEnabled }}
WHERE 
email_identity = '{{ email_identity }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_email_identity

Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.

DELETE FROM aws.pinpoint_email.email_identities
WHERE email_identity = '{{ email_identity }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

put_email_identity_feedback_attributes

Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event. When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

EXEC aws.pinpoint_email.email_identities.put_email_identity_feedback_attributes 
@email_identity='{{ email_identity }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"EmailForwardingEnabled": {{ EmailForwardingEnabled }}
}'
;

put_email_identity_mail_from_attributes

Used to enable or disable the custom Mail-From domain configuration for an email identity.

EXEC aws.pinpoint_email.email_identities.put_email_identity_mail_from_attributes 
@email_identity='{{ email_identity }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"MailFromDomain": "{{ MailFromDomain }}", 
"BehaviorOnMxFailure": "{{ BehaviorOnMxFailure }}"
}'
;