CreateEmailIdentity - Amazon SES API v2

CreateEmailIdentity

Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.

When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.

When you verify a domain without specifying the DkimSigningAttributes object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM.

Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key that you want to use for DKIM authentication) and a private key.

Request Syntax

POST /v2/email/identities HTTP/1.1 Content-type: application/json { "DkimSigningAttributes": { "DomainSigningPrivateKey": "string", "DomainSigningSelector": "string" }, "EmailIdentity": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DkimSigningAttributes

If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, as opposed to the default method, Easy DKIM.

You can only specify this object if the email identity is a domain, as opposed to an address.

Type: DkimSigningAttributes object

Required: No

EmailIdentity

The email address or domain that you want to verify.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Tags

An array of objects that define the tags (keys and values) that you want to associate with the email identity.

Type: Array of Tag objects

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DkimAttributes": { "SigningAttributesOrigin": "string", "SigningEnabled": boolean, "Status": "string", "Tokens": [ "string" ] }, "IdentityType": "string", "VerifiedForSendingStatus": boolean }

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.

DkimAttributes

An object that contains information about the DKIM attributes for the identity.

Type: DkimAttributes object

IdentityType

The email identity type.

Type: String

Valid Values: EMAIL_ADDRESS | DOMAIN | MANAGED_DOMAIN

VerifiedForSendingStatus

Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

Type: Boolean

Errors

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

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

ConcurrentModificationException

The resource is being modified by another operation or thread.

HTTP Status Code: 500

LimitExceededException

There are too many instances of the specified resource type.

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: