PinpointEmail / Client / put_email_identity_dkim_attributes

put_email_identity_dkim_attributes#

PinpointEmail.Client.put_email_identity_dkim_attributes(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.put_email_identity_dkim_attributes(
    EmailIdentity='string',
    SigningEnabled=True|False
)
Parameters:

  • EmailIdentity (string) –

    [REQUIRED]

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

  • SigningEnabled (boolean) –

    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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    An HTTP 200 response if the request succeeds, or an error message if the request fails.

Exceptions