Skip to content

Get Email Identity

sesv2_get_email_identity R Documentation

Provides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings

Description

Provides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings.

Usage

sesv2_get_email_identity(EmailIdentity)

Arguments

EmailIdentity

[required] The email identity.

Value

A list with the following syntax:

list(
  IdentityType = "EMAIL_ADDRESS"|"DOMAIN"|"MANAGED_DOMAIN",
  FeedbackForwardingStatus = TRUE|FALSE,
  VerifiedForSendingStatus = TRUE|FALSE,
  DkimAttributes = list(
    SigningEnabled = TRUE|FALSE,
    Status = "PENDING"|"SUCCESS"|"FAILED"|"TEMPORARY_FAILURE"|"NOT_STARTED",
    Tokens = list(
      "string"
    ),
    SigningAttributesOrigin = "AWS_SES"|"EXTERNAL"|"AWS_SES_AF_SOUTH_1"|"AWS_SES_EU_NORTH_1"|"AWS_SES_AP_SOUTH_1"|"AWS_SES_EU_WEST_3"|"AWS_SES_EU_WEST_2"|"AWS_SES_EU_SOUTH_1"|"AWS_SES_EU_WEST_1"|"AWS_SES_AP_NORTHEAST_3"|"AWS_SES_AP_NORTHEAST_2"|"AWS_SES_ME_SOUTH_1"|"AWS_SES_AP_NORTHEAST_1"|"AWS_SES_IL_CENTRAL_1"|"AWS_SES_SA_EAST_1"|"AWS_SES_CA_CENTRAL_1"|"AWS_SES_AP_SOUTHEAST_1"|"AWS_SES_AP_SOUTHEAST_2"|"AWS_SES_AP_SOUTHEAST_3"|"AWS_SES_EU_CENTRAL_1"|"AWS_SES_US_EAST_1"|"AWS_SES_US_EAST_2"|"AWS_SES_US_WEST_1"|"AWS_SES_US_WEST_2",
    NextSigningKeyLength = "RSA_1024_BIT"|"RSA_2048_BIT",
    CurrentSigningKeyLength = "RSA_1024_BIT"|"RSA_2048_BIT",
    LastKeyGenerationTimestamp = as.POSIXct(
      "2015-01-01"
    )
  ),
  MailFromAttributes = list(
    MailFromDomain = "string",
    MailFromDomainStatus = "PENDING"|"SUCCESS"|"FAILED"|"TEMPORARY_FAILURE",
    BehaviorOnMxFailure = "USE_DEFAULT_VALUE"|"REJECT_MESSAGE"
  ),
  Policies = list(
    "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  ConfigurationSetName = "string",
  VerificationStatus = "PENDING"|"SUCCESS"|"FAILED"|"TEMPORARY_FAILURE"|"NOT_STARTED",
  VerificationInfo = list(
    LastCheckedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    LastSuccessTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    ErrorType = "SERVICE_ERROR"|"DNS_SERVER_ERROR"|"HOST_NOT_FOUND"|"TYPE_NOT_FOUND"|"INVALID_VALUE"|"REPLICATION_ACCESS_DENIED"|"REPLICATION_PRIMARY_NOT_FOUND"|"REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED"|"REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED"|"REPLICATION_PRIMARY_INVALID_REGION",
    SOARecord = list(
      PrimaryNameServer = "string",
      AdminEmail = "string",
      SerialNumber = 123
    )
  )
)

Request syntax

svc$get_email_identity(
  EmailIdentity = "string"
)