Package software.amazon.awssdk.services.pinpointemail.model

Enum DkimStatus

java.lang.Object
java.lang.Enum<DkimStatus>
software.amazon.awssdk.services.pinpointemail.model.DkimStatus
All Implemented Interfaces:
Serializable, Comparable<DkimStatus>
@Generated("software.amazon.awssdk:codegen") public enum DkimStatus extends Enum<DkimStatus>

The DKIM authentication status of the identity. The status can be one of the following:

  • PENDING – The DKIM verification process was initiated, and Amazon Pinpoint is still waiting for the required CNAME records to appear in the DNS configuration for the domain.

  • SUCCESS – The DKIM authentication process completed successfully.

  • FAILED – The DKIM authentication process failed. This can happen when Amazon Pinpoint fails to find the required CNAME records in the DNS configuration of the domain.

  • TEMPORARY_FAILURE – A temporary issue is preventing Amazon Pinpoint from determining the DKIM authentication status of the domain.

  • NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.

  • Enum Constant Details

    • PENDING

      public static final DkimStatus PENDING

    • SUCCESS

      public static final DkimStatus SUCCESS

    • FAILED

      public static final DkimStatus FAILED

    • TEMPORARY_FAILURE

      public static final DkimStatus TEMPORARY_FAILURE

    • NOT_STARTED

      public static final DkimStatus NOT_STARTED

    • UNKNOWN_TO_SDK_VERSION

      public static final DkimStatus UNKNOWN_TO_SDK_VERSION

  • Method Details

    • values

      public static DkimStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static DkimStatus valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<DkimStatus>

    • fromValue

      public static DkimStatus fromValue(String value)
      Use this in place of valueOf to convert the raw string returned by the service into the enum value.
      Parameters:
      value - real value
      Returns:
      DkimStatus corresponding to the value

    • knownValues

      public static Set<DkimStatus> knownValues()
      Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.
      Returns:
      a Set of known DkimStatuss