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.sesv2.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.
tags	array	An array of objects that define the tags (keys and values) that are associated with the custom verification email template.
template_content	string	The content of the custom verification email template.
template_name	string	The name of the template. You will refer to this name when you send email using the SendEmail or SendBulkEmail operations.
template_subject	string	The subject line of the email.

list_custom_verification_email_templates

Name	Datatype	Description
custom_verification_email_templates	array	A list of the custom verification email templates that exist in your account.
next_token	string	A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListCustomVerificationEmailTemplates to retrieve the next 50 custom verification email templates.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_custom_verification_email_template	select	template_name, 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, PageSize	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	region, TemplateName, FromEmailAddress, TemplateSubject, TemplateContent, SuccessRedirectionURL, FailureRedirectionURL		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	template_name, 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	template_name, 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
region	string	AWS region (default: us-east-1)
template_name	string	The name of the custom verification email template that you want to delete.
NextToken	string	A token returned from a previous call to ListCustomVerificationEmailTemplates to indicate the position in the list of custom verification email templates.
PageSize	integer	The number of results to show in a single call to ListCustomVerificationEmailTemplates. 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 1, and can be no more than 50.

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,
tags,
template_content,
template_name,
template_subject
FROM aws.sesv2.custom_verification_email_templates
WHERE template_name = '{{ template_name }}' -- 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
custom_verification_email_templates,
next_token
FROM aws.sesv2.custom_verification_email_templates
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND PageSize = '{{ PageSize }}'
;

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.sesv2.custom_verification_email_templates (
TemplateName,
FromEmailAddress,
TemplateSubject,
TemplateContent,
Tags,
SuccessRedirectionURL,
FailureRedirectionURL,
region
)
SELECT 
'{{ TemplateName }}' /* required */,
'{{ FromEmailAddress }}' /* required */,
'{{ TemplateSubject }}' /* required */,
'{{ TemplateContent }}' /* required */,
'{{ Tags }}',
'{{ SuccessRedirectionURL }}' /* required */,
'{{ FailureRedirectionURL }}' /* required */,
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: custom_verification_email_templates
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the custom_verification_email_templates resource.
  - name: TemplateName
    value: "{{ TemplateName }}"
    description: |
      The name of the template. You will refer to this name when you send email using the SendEmail or SendBulkEmail operations.
  - name: FromEmailAddress
    value: "{{ FromEmailAddress }}"
  - name: TemplateSubject
    value: "{{ TemplateSubject }}"
    description: |
      The subject line of the email.
  - name: TemplateContent
    value: "{{ TemplateContent }}"
    description: |
      The content of the custom verification email template.
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: SuccessRedirectionURL
    value: "{{ SuccessRedirectionURL }}"
    description: |
      The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
  - name: FailureRedirectionURL
    value: "{{ FailureRedirectionURL }}"
    description: |
      The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

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.sesv2.custom_verification_email_templates
SET 
FromEmailAddress = '{{ FromEmailAddress }}',
TemplateSubject = '{{ TemplateSubject }}',
TemplateContent = '{{ TemplateContent }}',
SuccessRedirectionURL = '{{ SuccessRedirectionURL }}',
FailureRedirectionURL = '{{ FailureRedirectionURL }}'
WHERE 
template_name = '{{ template_name }}' --required
AND region = '{{ region }}' --required
AND FromEmailAddress = '{{ FromEmailAddress }}' --required
AND TemplateSubject = '{{ TemplateSubject }}' --required
AND TemplateContent = '{{ TemplateContent }}' --required
AND SuccessRedirectionURL = '{{ SuccessRedirectionURL }}' --required
AND FailureRedirectionURL = '{{ FailureRedirectionURL }}' --required;

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.sesv2.custom_verification_email_templates
WHERE template_name = '{{ template_name }}' --required
AND region = '{{ region }}' --required
;