SES / Client / get_custom_verification_email_template

get_custom_verification_email_template

SES.Client.get_custom_verification_email_template(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_custom_verification_email_template(
    TemplateName='string'
)

Parameters:

TemplateName (string) –

[REQUIRED]

The name of the custom verification email template that you want to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'TemplateName': 'string',
    'FromEmailAddress': 'string',
    'TemplateSubject': 'string',
    'TemplateContent': 'string',
    'SuccessRedirectionURL': 'string',
    'FailureRedirectionURL': 'string'
}

Response Structure

• (dict) –

  The content of the custom verification email template.

  • TemplateName (string) –

    The name of the custom verification email template.

  • FromEmailAddress (string) –

    The email address that the custom verification email is sent from.

  • TemplateSubject (string) –

    The subject line of the custom verification email.

  • TemplateContent (string) –

    The content of the custom verification email.

  • SuccessRedirectionURL (string) –

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

  • FailureRedirectionURL (string) –

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

Exceptions

• SES.Client.exceptions.CustomVerificationEmailTemplateDoesNotExistException