Amazon Pinpoint Email Service
API Reference (API Version 2018-07-26)

PutEmailIdentityDkimAttributes

Used to enable or disable DKIM authentication for an email identity.

Request Syntax

PUT /v1/email/identities/EmailIdentity/dkim HTTP/1.1 Content-type: application/json { "SigningEnabled": boolean }

URI Request Parameters

The request requires the following URI parameters.

EmailIdentity

The email identity that you want to change the DKIM settings for.

Request Body

The request accepts the following data in JSON format.

SigningEnabled

Sets the DKIM signing configuration for the identity.

When you set this value true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. When you set this value to false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.

Type: Boolean

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

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

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: