Skip to content

Put Email Identity Dkim Signing Attributes

sesv2_put_email_identity_dkim_signing_attributes R Documentation

Used to configure or change the DKIM authentication settings for an email domain identity

Description

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:

  • Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).

  • Update the key length that should be used for Easy DKIM.

  • Change from using no DKIM authentication to using Easy DKIM.

  • Change from using no DKIM authentication to using BYODKIM.

  • Change from using Easy DKIM to using BYODKIM.

  • Change from using BYODKIM to using Easy DKIM.

Usage

sesv2_put_email_identity_dkim_signing_attributes(EmailIdentity,
  SigningAttributesOrigin, SigningAttributes)

Arguments

EmailIdentity

[required] The email identity.

SigningAttributesOrigin

[required] The method to use to configure DKIM for the identity. There are the following possible values:

  • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

  • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

SigningAttributes

An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.

Value

A list with the following syntax: 

list(
  DkimStatus = "PENDING"|"SUCCESS"|"FAILED"|"TEMPORARY_FAILURE"|"NOT_STARTED",
  DkimTokens = list(
    "string"
  )
)

Request syntax

svc$put_email_identity_dkim_signing_attributes(
  EmailIdentity = "string",
  SigningAttributesOrigin = "AWS_SES"|"EXTERNAL",
  SigningAttributes = list(
    DomainSigningSelector = "string",
    DomainSigningPrivateKey = "string",
    NextSigningKeyLength = "RSA_1024_BIT"|"RSA_2048_BIT"
  )
)