SES / Client / list_custom_verification_email_templates

list_custom_verification_email_templates#

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

Request Syntax

response = client.list_custom_verification_email_templates(
    NextToken='string',
    MaxResults=123
)

Parameters:

NextToken (string) – An array the contains the name and creation time stamp for each template in your Amazon SES account.
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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

A paginated list of custom verification email templates.
- 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 ListTemplates to retrieve the next 50 custom verification email templates.