SES / Paginator / ListCustomVerificationEmailTemplates

ListCustomVerificationEmailTemplates#

class SES.Paginator.ListCustomVerificationEmailTemplates#
paginator = client.get_paginator('list_custom_verification_email_templates')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SES.Client.list_custom_verification_email_templates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'CustomVerificationEmailTemplates': [
        {
            'TemplateName': 'string',
            'FromEmailAddress': 'string',
            'TemplateSubject': 'string',
            'SuccessRedirectionURL': 'string',
            'FailureRedirectionURL': '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.