SESV2 / Client / list_custom_verification_email_templates

list_custom_verification_email_templates#

SESV2.Client.list_custom_verification_email_templates(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_custom_verification_email_templates(
    NextToken='string',
    PageSize=123
)
Parameters:

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'CustomVerificationEmailTemplates': [
        {
            'TemplateName': 'string',
            'FromEmailAddress': 'string',
            'TemplateSubject': 'string',
            'SuccessRedirectionURL': 'string',
            'FailureRedirectionURL': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    The following elements are returned by the service.

    • CustomVerificationEmailTemplates (list) –

      A list of the custom verification email templates that exist in your account.

      • (dict) –

        Contains information about a 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.

        • 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.

    • NextToken (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.

Exceptions