custom_verification_email_templates

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

Overview

Name	custom_verification_email_templates
Type	Resource
Id	aws.ses.custom_verification_email_templates

Fields

The following fields are returned by SELECT queries:

get_custom_verification_email_template

Name	Datatype	Description
failure_redirection_url	string	The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
from_email_address	string	The email address that the custom verification email is sent from.
success_redirection_url	string	The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
template_content	string	The content of the custom verification email.
template_name	string	The name of the custom verification email template.
template_subject	string	The subject line of the custom verification email.

list_custom_verification_email_templates

Name	Datatype	Description
failure_redirection_url	string	The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
from_email_address	string	The email address that the custom verification email is sent from.
success_redirection_url	string	The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
template_name	string	The name of the custom verification email template.
template_subject	string	The subject line of the custom verification email.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_custom_verification_email_template	select	TemplateName, region		Returns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
list_custom_verification_email_templates	select	region	NextToken, MaxResults	Lists the existing custom verification email templates for your account in the current Amazon Web Services Region. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
create_custom_verification_email_template	insert	TemplateName, FromEmailAddress, TemplateSubject, TemplateContent, SuccessRedirectionURL, FailureRedirectionURL, region		Creates a new custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
update_custom_verification_email_template	update	TemplateName, region	FromEmailAddress, TemplateSubject, TemplateContent, SuccessRedirectionURL, FailureRedirectionURL	Updates an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
delete_custom_verification_email_template	delete	TemplateName, region		Deletes an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in 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
FailureRedirectionURL	string	The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
FromEmailAddress	string	The email address that the custom verification email is sent from.
SuccessRedirectionURL	string	The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
TemplateContent	string	The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
TemplateName	string	The name of the custom verification email template to delete.
TemplateSubject	string	The subject line of the custom verification email.
region	string	AWS region (default: us-east-1)
FailureRedirectionURL	string	The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
FromEmailAddress	string	The email address that the custom verification email is sent from.
MaxResults	integer	The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation returns up to 50 results.
NextToken	string	An array the contains the name and creation time stamp for each template in your Amazon SES account.
SuccessRedirectionURL	string	The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
TemplateContent	string	The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
TemplateSubject	string	The subject line of the custom verification email.

SELECT examples

get_custom_verification_email_template

Returns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.

SELECT
failure_redirection_url,
from_email_address,
success_redirection_url,
template_content,
template_name,
template_subject
FROM aws.ses.custom_verification_email_templates
WHERE TemplateName = '{{ TemplateName }}' -- required
AND region = '{{ region }}' -- required
;

list_custom_verification_email_templates

Lists the existing custom verification email templates for your account in the current Amazon Web Services Region. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.

SELECT
failure_redirection_url,
from_email_address,
success_redirection_url,
template_name,
template_subject
FROM aws.ses.custom_verification_email_templates
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

INSERT examples

create_custom_verification_email_template

Creates a new custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.

INSERT INTO aws.ses.custom_verification_email_templates (
TemplateName,
FromEmailAddress,
TemplateSubject,
TemplateContent,
SuccessRedirectionURL,
FailureRedirectionURL,
region
)
SELECT 
'{{ TemplateName }}',
'{{ FromEmailAddress }}',
'{{ TemplateSubject }}',
'{{ TemplateContent }}',
'{{ SuccessRedirectionURL }}',
'{{ FailureRedirectionURL }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: custom_verification_email_templates
props:
  - name: TemplateName
    value: "{{ TemplateName }}"
    description: Required parameter for the custom_verification_email_templates resource.
  - name: FromEmailAddress
    value: "{{ FromEmailAddress }}"
    description: Required parameter for the custom_verification_email_templates resource.
  - name: TemplateSubject
    value: "{{ TemplateSubject }}"
    description: Required parameter for the custom_verification_email_templates resource.
  - name: TemplateContent
    value: "{{ TemplateContent }}"
    description: Required parameter for the custom_verification_email_templates resource.
  - name: SuccessRedirectionURL
    value: "{{ SuccessRedirectionURL }}"
    description: Required parameter for the custom_verification_email_templates resource.
  - name: FailureRedirectionURL
    value: "{{ FailureRedirectionURL }}"
    description: Required parameter for the custom_verification_email_templates resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the custom_verification_email_templates resource.

UPDATE examples

update_custom_verification_email_template

Updates an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.

UPDATE aws.ses.custom_verification_email_templates
SET 
-- No updatable properties
WHERE 
TemplateName = '{{ TemplateName }}' --required
AND region = '{{ region }}' --required
AND FromEmailAddress = '{{ FromEmailAddress}}'
AND TemplateSubject = '{{ TemplateSubject}}'
AND TemplateContent = '{{ TemplateContent}}'
AND SuccessRedirectionURL = '{{ SuccessRedirectionURL}}'
AND FailureRedirectionURL = '{{ FailureRedirectionURL}}';

DELETE examples

delete_custom_verification_email_template

Deletes an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.

DELETE FROM aws.ses.custom_verification_email_templates
WHERE TemplateName = '{{ TemplateName }}' --required
AND region = '{{ region }}' --required
;