Class: Aws::SESV2::Types::PutEmailIdentityDkimSigningAttributesResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb

Overview

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

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dkim_status ⇒ String

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.

Returns:

  • (String) 


7242
7243
7244
7245
7246
7247
7248
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 7242

class PutEmailIdentityDkimSigningAttributesResponse < Struct.new(
  :dkim_status,
  :dkim_tokens,
  :signing_hosted_zone)
  SENSITIVE = []
  include Aws::Structure
end

#dkim_tokens ⇒ Array<String>

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.

Returns:

  • (Array<String>) 


7242
7243
7244
7245
7246
7247
7248
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 7242

class PutEmailIdentityDkimSigningAttributesResponse < Struct.new(
  :dkim_status,
  :dkim_tokens,
  :signing_hosted_zone)
  SENSITIVE = []
  include Aws::Structure
end

#signing_hosted_zone ⇒ String

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:

  • (String) 


7242
7243
7244
7245
7246
7247
7248
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 7242

class PutEmailIdentityDkimSigningAttributesResponse < Struct.new(
  :dkim_status,
  :dkim_tokens,
  :signing_hosted_zone)
  SENSITIVE = []
  include Aws::Structure
end