paws.customer.engagement (version 0.1.12)

ses_get_identity_dkim_attributes: Returns the current status of Easy DKIM signing for an entity

Description

Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.

This operation takes a list of identities as input and returns the following information for each:

• Whether Easy DKIM signing is enabled or disabled.

• A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.

• Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.

This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

Usage

ses_get_identity_dkim_attributes(Identities)

Value

A list with the following syntax:

list(
  DkimAttributes = list(
    list(
      DkimEnabled = TRUE|FALSE,
      DkimVerificationStatus = "Pending"|"Success"|"Failed"|"TemporaryFailure"|"NotStarted",
      DkimTokens = list(
        "string"
      )
    )
  )
)

Arguments

Identities

[required] A list of one or more verified identities - email addresses, domains, or both.

Request syntax

svc$get_identity_dkim_attributes(
  Identities = list(
    "string"
  )
)

Examples

if (FALSE) {
# The following example retrieves the Amazon SES Easy DKIM attributes for
# a list of identities:
svc$get_identity_dkim_attributes(
  Identities = list(
    "example.com",
    "[e-mail]"
  )
)
}