PUT

/v1/email/identities/{EmailIdentity}/dkim/signing

http://email.{region}.amazonaws.com/v1/email/identities/{EmailIdentity}/dkim/signing

Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following: <ul> <li> Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM). </li> <li> Update the key length that should be used for Easy DKIM. </li> <li> Change from using no DKIM authentication to using Easy DKIM. </li> <li> Change from using no DKIM authentication to using BYODKIM. </li> <li> Change from using Easy DKIM to using BYODKIM. </li> <li> Change from using BYODKIM to using Easy DKIM. </li> </ul>

Access Token Required: API Key

Path Parameters

EmailIdentitystringrequired

The email identity.

Body Params

SigningAttributesobject

An object that contains configuration for Bring Your Own DKIM (BYODKIM), or, for Easy DKIM

SigningAttributesOriginstringrequired

The method to use to configure DKIM for the identity. There are the following possible values: <ul> <li> <code>AWS_SES</code> – Configure DKIM for the identity by using <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a>. </li> <li> <code>EXTERNAL</code> – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM). </li> </ul>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://email.{region}.amazonaws.com/v1/email/identities/{EmailIdentity}/dkim/signing' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}