Class VerificationInfo

java.lang.Object
software.amazon.awssdk.services.sesv2.model.VerificationInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VerificationInfo.Builder,VerificationInfo>
@Generated("software.amazon.awssdk:codegen") public final class VerificationInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VerificationInfo.Builder,VerificationInfo>

An object that contains additional information about the verification status for the identity.

See Also:

  • Method Details

    • lastCheckedTimestamp

      public final Instant lastCheckedTimestamp()

      The last time a verification attempt was made for this identity.

      Returns:
      The last time a verification attempt was made for this identity.

    • lastSuccessTimestamp

      public final Instant lastSuccessTimestamp()

      The last time a successful verification was made for this identity.

      Returns:
      The last time a successful verification was made for this identity.

    • errorType

      public final VerificationError errorType()

      Provides the reason for the failure describing why Amazon SES was not able to successfully verify the identity. Below are the possible values:

      • INVALID_VALUE – Amazon SES was able to find the record, but the value contained within the record was invalid. Ensure you have published the correct values for the record.

      • TYPE_NOT_FOUND – The queried hostname exists but does not have the requested type of DNS record. Ensure that you have published the correct type of DNS record.

      • HOST_NOT_FOUND – The queried hostname does not exist or was not reachable at the time of the request. Ensure that you have published the required DNS record(s).

      • SERVICE_ERROR – A temporary issue is preventing Amazon SES from determining the verification status of the domain.

      • DNS_SERVER_ERROR – The DNS server encountered an issue and was unable to complete the request.

      • REPLICATION_ACCESS_DENIED – The verification failed because the user does not have the required permissions to replicate the DKIM key from the primary region. Ensure you have the necessary permissions in both primary and replica regions.

      • REPLICATION_PRIMARY_NOT_FOUND – The verification failed because no corresponding identity was found in the specified primary region. Ensure the identity exists in the primary region before attempting replication.

      • REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED – The verification failed because the identity in the primary region is configured with Bring Your Own DKIM (BYODKIM). DKIM key replication is only supported for identities using Easy DKIM.

      • REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED – The verification failed because the specified primary identity is a replica of another identity, and multi-level replication is not supported; the primary identity must be a non-replica identity.

      • REPLICATION_PRIMARY_INVALID_REGION – The verification failed due to an invalid primary region specified. Ensure you provide a valid Amazon Web Services region where Amazon SES is available and different from the replica region.

      If the service returns an enum value that is not available in the current SDK version, errorType will return VerificationError.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorTypeAsString().

      Returns:
      Provides the reason for the failure describing why Amazon SES was not able to successfully verify the identity. Below are the possible values:

      • INVALID_VALUE – Amazon SES was able to find the record, but the value contained within the record was invalid. Ensure you have published the correct values for the record.

      • TYPE_NOT_FOUND – The queried hostname exists but does not have the requested type of DNS record. Ensure that you have published the correct type of DNS record.

      • HOST_NOT_FOUND – The queried hostname does not exist or was not reachable at the time of the request. Ensure that you have published the required DNS record(s).

      • SERVICE_ERROR – A temporary issue is preventing Amazon SES from determining the verification status of the domain.

      • DNS_SERVER_ERROR – The DNS server encountered an issue and was unable to complete the request.

      • REPLICATION_ACCESS_DENIED – The verification failed because the user does not have the required permissions to replicate the DKIM key from the primary region. Ensure you have the necessary permissions in both primary and replica regions.

      • REPLICATION_PRIMARY_NOT_FOUND – The verification failed because no corresponding identity was found in the specified primary region. Ensure the identity exists in the primary region before attempting replication.

      • REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED – The verification failed because the identity in the primary region is configured with Bring Your Own DKIM (BYODKIM). DKIM key replication is only supported for identities using Easy DKIM.

      • REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED – The verification failed because the specified primary identity is a replica of another identity, and multi-level replication is not supported; the primary identity must be a non-replica identity.

      • REPLICATION_PRIMARY_INVALID_REGION – The verification failed due to an invalid primary region specified. Ensure you provide a valid Amazon Web Services region where Amazon SES is available and different from the replica region.

      See Also:

    • errorTypeAsString

      public final String errorTypeAsString()

      Provides the reason for the failure describing why Amazon SES was not able to successfully verify the identity. Below are the possible values:

      • INVALID_VALUE – Amazon SES was able to find the record, but the value contained within the record was invalid. Ensure you have published the correct values for the record.

      • TYPE_NOT_FOUND – The queried hostname exists but does not have the requested type of DNS record. Ensure that you have published the correct type of DNS record.

      • HOST_NOT_FOUND – The queried hostname does not exist or was not reachable at the time of the request. Ensure that you have published the required DNS record(s).

      • SERVICE_ERROR – A temporary issue is preventing Amazon SES from determining the verification status of the domain.

      • DNS_SERVER_ERROR – The DNS server encountered an issue and was unable to complete the request.

      • REPLICATION_ACCESS_DENIED – The verification failed because the user does not have the required permissions to replicate the DKIM key from the primary region. Ensure you have the necessary permissions in both primary and replica regions.

      • REPLICATION_PRIMARY_NOT_FOUND – The verification failed because no corresponding identity was found in the specified primary region. Ensure the identity exists in the primary region before attempting replication.

      • REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED – The verification failed because the identity in the primary region is configured with Bring Your Own DKIM (BYODKIM). DKIM key replication is only supported for identities using Easy DKIM.

      • REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED – The verification failed because the specified primary identity is a replica of another identity, and multi-level replication is not supported; the primary identity must be a non-replica identity.

      • REPLICATION_PRIMARY_INVALID_REGION – The verification failed due to an invalid primary region specified. Ensure you provide a valid Amazon Web Services region where Amazon SES is available and different from the replica region.

      If the service returns an enum value that is not available in the current SDK version, errorType will return VerificationError.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorTypeAsString().

      Returns:
      Provides the reason for the failure describing why Amazon SES was not able to successfully verify the identity. Below are the possible values:

      • INVALID_VALUE – Amazon SES was able to find the record, but the value contained within the record was invalid. Ensure you have published the correct values for the record.

      • TYPE_NOT_FOUND – The queried hostname exists but does not have the requested type of DNS record. Ensure that you have published the correct type of DNS record.

      • HOST_NOT_FOUND – The queried hostname does not exist or was not reachable at the time of the request. Ensure that you have published the required DNS record(s).

      • SERVICE_ERROR – A temporary issue is preventing Amazon SES from determining the verification status of the domain.

      • DNS_SERVER_ERROR – The DNS server encountered an issue and was unable to complete the request.

      • REPLICATION_ACCESS_DENIED – The verification failed because the user does not have the required permissions to replicate the DKIM key from the primary region. Ensure you have the necessary permissions in both primary and replica regions.

      • REPLICATION_PRIMARY_NOT_FOUND – The verification failed because no corresponding identity was found in the specified primary region. Ensure the identity exists in the primary region before attempting replication.

      • REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED – The verification failed because the identity in the primary region is configured with Bring Your Own DKIM (BYODKIM). DKIM key replication is only supported for identities using Easy DKIM.

      • REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED – The verification failed because the specified primary identity is a replica of another identity, and multi-level replication is not supported; the primary identity must be a non-replica identity.

      • REPLICATION_PRIMARY_INVALID_REGION – The verification failed due to an invalid primary region specified. Ensure you provide a valid Amazon Web Services region where Amazon SES is available and different from the replica region.

      See Also:

    • soaRecord

      public final SOARecord soaRecord()

      An object that contains information about the start of authority (SOA) record associated with the identity.

      Returns:
      An object that contains information about the start of authority (SOA) record associated with the identity.

    • toBuilder

      public VerificationInfo.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<VerificationInfo.Builder,VerificationInfo>
      Returns:
      a builder for type T

    • builder

      public static VerificationInfo.Builder builder()

    • serializableBuilderClass

      public static Class<? extends VerificationInfo.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.