Package software.amazon.awssdk.services.sesv2.model

Class PutEmailIdentityDkimSigningAttributesResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sesv2.model.SesV2Response
software.amazon.awssdk.services.sesv2.model.PutEmailIdentityDkimSigningAttributesResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutEmailIdentityDkimSigningAttributesResponse.Builder,PutEmailIdentityDkimSigningAttributesResponse>
@Generated("software.amazon.awssdk:codegen") public final class PutEmailIdentityDkimSigningAttributesResponse extends SesV2Response implements ToCopyableBuilder<PutEmailIdentityDkimSigningAttributesResponse.Builder,PutEmailIdentityDkimSigningAttributesResponse>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

  • Method Details

    • dkimStatus

      public final DkimStatus dkimStatus()

      The DKIM authentication status of the identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for your domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain.

      If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity.

      The status can be one of the following:

      • PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.

      • SUCCESS – The verification process completed successfully.

      • FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.

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

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

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

      Returns:
      The DKIM authentication status of the identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for your domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain.

      If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity.

      The status can be one of the following:

      • PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.

      • SUCCESS – The verification process completed successfully.

      • FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.

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

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

      See Also:

    • dkimStatusAsString

      public final String dkimStatusAsString()

      The DKIM authentication status of the identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for your domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain.

      If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity.

      The status can be one of the following:

      • PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.

      • SUCCESS – The verification process completed successfully.

      • FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.

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

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

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

      Returns:
      The DKIM authentication status of the identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for your domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain.

      If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity.

      The status can be one of the following:

      • PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.

      • SUCCESS – The verification process completed successfully.

      • FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.

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

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

      See Also:

    • hasDkimTokens

      public final boolean hasDkimTokens()
      For responses, this returns true if the service returned a value for the DkimTokens property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • dkimTokens

      public final List<String> dkimTokens()

      If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.

      If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector that's associated with your public key.

      Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDkimTokens() method.

      Returns:
      If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.

      If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector that's associated with your public key.

      Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.

    • signingHostedZone

      public final String signingHostedZone()

      The hosted zone where Amazon SES publishes the DKIM public key TXT records for this email identity. This value indicates the DNS zone that customers must reference when configuring their CNAME records for DKIM authentication.

      When configuring DKIM for your domain, create CNAME records in your DNS that point to the selectors in this hosted zone. For example:

      selector1._domainkey.yourdomain.com CNAME selector1.<SigningHostedZone>

      selector2._domainkey.yourdomain.com CNAME selector2.<SigningHostedZone>

      selector3._domainkey.yourdomain.com CNAME selector3.<SigningHostedZone>

      Returns:
      The hosted zone where Amazon SES publishes the DKIM public key TXT records for this email identity. This value indicates the DNS zone that customers must reference when configuring their CNAME records for DKIM authentication.

      When configuring DKIM for your domain, create CNAME records in your DNS that point to the selectors in this hosted zone. For example:

      selector1._domainkey.yourdomain.com CNAME selector1.<SigningHostedZone>

      selector2._domainkey.yourdomain.com CNAME selector2.<SigningHostedZone>

      selector3._domainkey.yourdomain.com CNAME selector3.<SigningHostedZone>

    • toBuilder

      public PutEmailIdentityDkimSigningAttributesResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutEmailIdentityDkimSigningAttributesResponse.Builder,PutEmailIdentityDkimSigningAttributesResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static PutEmailIdentityDkimSigningAttributesResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo