GetCustomVerificationEmailTemplate - Amazon SES API v2

GetCustomVerificationEmailTemplate

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.

Request Syntax

GET /v2/email/custom-verification-email-templates/TemplateName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

TemplateName

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

Length Constraints: Minimum length of 1.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "FailureRedirectionURL": "string", "FromEmailAddress": "string", "SuccessRedirectionURL": "string", "TemplateContent": "string", "TemplateName": "string", "TemplateSubject": "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.

FailureRedirectionURL

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

Type: String

FromEmailAddress

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

Type: String

SuccessRedirectionURL

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

Type: String

TemplateContent

The content of the custom verification email.

Type: String

TemplateName

The name of the custom verification email template.

Type: String

Length Constraints: Minimum length of 1.

TemplateSubject

The subject line of the custom verification email.

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

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

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: