Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SESV2.Types.DkimAttributes

Description

Synopsis

data DkimAttributes = DkimAttributes' {
- status :: Maybe DkimStatus
- nextSigningKeyLength :: Maybe DkimSigningKeyLength
- tokens :: Maybe [Text]
- signingEnabled :: Maybe Bool
- currentSigningKeyLength :: Maybe DkimSigningKeyLength
- lastKeyGenerationTimestamp :: Maybe POSIX
- signingAttributesOrigin :: Maybe DkimSigningAttributesOrigin
}
newDkimAttributes :: DkimAttributes
dkimAttributes_status :: Lens' DkimAttributes (Maybe DkimStatus)
dkimAttributes_nextSigningKeyLength :: Lens' DkimAttributes (Maybe DkimSigningKeyLength)
dkimAttributes_tokens :: Lens' DkimAttributes (Maybe [Text])
dkimAttributes_signingEnabled :: Lens' DkimAttributes (Maybe Bool)
dkimAttributes_currentSigningKeyLength :: Lens' DkimAttributes (Maybe DkimSigningKeyLength)
dkimAttributes_lastKeyGenerationTimestamp :: Lens' DkimAttributes (Maybe UTCTime)
dkimAttributes_signingAttributesOrigin :: Lens' DkimAttributes (Maybe DkimSigningAttributesOrigin)

Documentation

data DkimAttributes Source #

An object that contains information about the DKIM authentication status for an email identity.

Amazon SES determines the authentication status by searching for specific records in the DNS configuration for the 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

See: newDkimAttributes smart constructor.

Constructors

DkimAttributes'

Fields

status :: Maybe DkimStatus
Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. 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.
nextSigningKeyLength :: Maybe DkimSigningKeyLength
Easy DKIM
The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
tokens :: Maybe [Text]
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 for the 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.
signingEnabled :: Maybe Bool
If the value is true, then the messages that you send from the identity are signed using DKIM. If the value is false, then the messages that you send from the identity aren't DKIM-signed.
currentSigningKeyLength :: Maybe DkimSigningKeyLength
Easy DKIM
The key length of the DKIM key pair in use.
lastKeyGenerationTimestamp :: Maybe POSIX
Easy DKIM
The last time a key pair was generated for this identity.
signingAttributesOrigin :: Maybe DkimSigningAttributesOrigin
A string that indicates how DKIM was configured for the identity. These are the possible values:
- AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM.
- EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).

Instances

Instances details

Eq DkimAttributes Source #
Instance details Defined in Amazonka.SESV2.Types.DkimAttributes Methods (==) :: DkimAttributes -> DkimAttributes -> Bool # (/=) :: DkimAttributes -> DkimAttributes -> Bool #
Read DkimAttributes Source #
Instance details Defined in Amazonka.SESV2.Types.DkimAttributes Methods readsPrec :: Int -> ReadS DkimAttributes # readList :: ReadS [DkimAttributes] # readPrec :: ReadPrec DkimAttributes # readListPrec :: ReadPrec [DkimAttributes] #
Show DkimAttributes Source #
Instance details Defined in Amazonka.SESV2.Types.DkimAttributes Methods showsPrec :: Int -> DkimAttributes -> ShowS # show :: DkimAttributes -> String # showList :: [DkimAttributes] -> ShowS #
Generic DkimAttributes Source #
Instance details Defined in Amazonka.SESV2.Types.DkimAttributes Associated Types type Rep DkimAttributes :: Type -> Type # Methods from :: DkimAttributes -> Rep DkimAttributes x # to :: Rep DkimAttributes x -> DkimAttributes #
NFData DkimAttributes Source #
Instance details Defined in Amazonka.SESV2.Types.DkimAttributes Methods rnf :: DkimAttributes -> () #
Hashable DkimAttributes Source #
Instance details Defined in Amazonka.SESV2.Types.DkimAttributes Methods hashWithSalt :: Int -> DkimAttributes -> Int # hash :: DkimAttributes -> Int #
FromJSON DkimAttributes Source #
Instance details Defined in Amazonka.SESV2.Types.DkimAttributes Methods parseJSON :: Value -> Parser DkimAttributes # parseJSONList :: Value -> Parser [DkimAttributes] #
type Rep DkimAttributes Source #
Instance details Defined in Amazonka.SESV2.Types.DkimAttributes type Rep DkimAttributes = D1 ('MetaData "DkimAttributes" "Amazonka.SESV2.Types.DkimAttributes" "libZSservicesZSamazonka-sesv2ZSamazonka-sesv2" 'False) (C1 ('MetaCons "DkimAttributes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DkimStatus)) :: (S1 ('MetaSel ('Just "nextSigningKeyLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DkimSigningKeyLength)) :: S1 ('MetaSel ('Just "tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "signingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "currentSigningKeyLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DkimSigningKeyLength))) :: (S1 ('MetaSel ('Just "lastKeyGenerationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "signingAttributesOrigin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DkimSigningAttributesOrigin))))))

newDkimAttributes :: DkimAttributes Source #

Create a value of DkimAttributes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:DkimAttributes', dkimAttributes_status - Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. 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.

$sel:nextSigningKeyLength:DkimAttributes', dkimAttributes_nextSigningKeyLength - [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

$sel:tokens:DkimAttributes', dkimAttributes_tokens - 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 for the 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.

$sel:signingEnabled:DkimAttributes', dkimAttributes_signingEnabled - If the value is true, then the messages that you send from the identity are signed using DKIM. If the value is false, then the messages that you send from the identity aren't DKIM-signed.

$sel:currentSigningKeyLength:DkimAttributes', dkimAttributes_currentSigningKeyLength - [Easy DKIM] The key length of the DKIM key pair in use.

$sel:lastKeyGenerationTimestamp:DkimAttributes', dkimAttributes_lastKeyGenerationTimestamp - [Easy DKIM] The last time a key pair was generated for this identity.

$sel:signingAttributesOrigin:DkimAttributes', dkimAttributes_signingAttributesOrigin - A string that indicates how DKIM was configured for the identity. These are the possible values:

AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM.
EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).

dkimAttributes_status :: Lens' DkimAttributes (Maybe DkimStatus) Source #

Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. 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.

dkimAttributes_nextSigningKeyLength :: Lens' DkimAttributes (Maybe DkimSigningKeyLength) Source #

Easy DKIM: The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

dkimAttributes_tokens :: Lens' DkimAttributes (Maybe [Text]) Source #

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 for the 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.

dkimAttributes_signingEnabled :: Lens' DkimAttributes (Maybe Bool) Source #

If the value is true, then the messages that you send from the identity are signed using DKIM. If the value is false, then the messages that you send from the identity aren't DKIM-signed.

dkimAttributes_currentSigningKeyLength :: Lens' DkimAttributes (Maybe DkimSigningKeyLength) Source #

Easy DKIM: The key length of the DKIM key pair in use.

dkimAttributes_lastKeyGenerationTimestamp :: Lens' DkimAttributes (Maybe UTCTime) Source #

Easy DKIM: The last time a key pair was generated for this identity.

dkimAttributes_signingAttributesOrigin :: Lens' DkimAttributes (Maybe DkimSigningAttributesOrigin) Source #

A string that indicates how DKIM was configured for the identity. These are the possible values:

AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM.
EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).