ListCustomVerificationEmailTemplates - Amazon SES API v2

ListCustomVerificationEmailTemplates

Lists the existing custom verification email templates for your account in the current AWS 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

GET /v2/email/custom-verification-email-templates?NextToken=NextToken&PageSize=PageSize HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

NextToken

A token returned from a previous call to ListCustomVerificationEmailTemplates to indicate the position in the list of custom verification email templates.

PageSize

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.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CustomVerificationEmailTemplates": [ { "FailureRedirectionURL": "string", "FromEmailAddress": "string", "SuccessRedirectionURL": "string", "TemplateName": "string", "TemplateSubject": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CustomVerificationEmailTemplates

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

Type: Array of CustomVerificationEmailTemplateMetadata objects

NextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: