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.PinpointEmail.Types.DkimAttributes

Description

Synopsis

Documentation

data DkimAttributes Source #

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

See: newDkimAttributes smart constructor.

Constructors

DkimAttributes'

Fields

status :: Maybe DkimStatus
Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
- PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.
- SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity.
- FAILED – Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.
- TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain.
- NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.
tokens :: Maybe [Text]
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 Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.
signingEnabled :: Maybe Bool
If the value is true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value is false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.

Instances

Instances details

Eq DkimAttributes Source #
Instance details Defined in Amazonka.PinpointEmail.Types.DkimAttributes Methods (==) :: DkimAttributes -> DkimAttributes -> Bool # (/=) :: DkimAttributes -> DkimAttributes -> Bool #
Read DkimAttributes Source #
Instance details Defined in Amazonka.PinpointEmail.Types.DkimAttributes Methods readsPrec :: Int -> ReadS DkimAttributes # readList :: ReadS [DkimAttributes] # readPrec :: ReadPrec DkimAttributes # readListPrec :: ReadPrec [DkimAttributes] #
Show DkimAttributes Source #
Instance details Defined in Amazonka.PinpointEmail.Types.DkimAttributes Methods showsPrec :: Int -> DkimAttributes -> ShowS # show :: DkimAttributes -> String # showList :: [DkimAttributes] -> ShowS #
Generic DkimAttributes Source #
Instance details Defined in Amazonka.PinpointEmail.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.PinpointEmail.Types.DkimAttributes Methods rnf :: DkimAttributes -> () #
Hashable DkimAttributes Source #
Instance details Defined in Amazonka.PinpointEmail.Types.DkimAttributes Methods hashWithSalt :: Int -> DkimAttributes -> Int # hash :: DkimAttributes -> Int #
FromJSON DkimAttributes Source #
Instance details Defined in Amazonka.PinpointEmail.Types.DkimAttributes Methods parseJSON :: Value -> Parser DkimAttributes # parseJSONList :: Value -> Parser [DkimAttributes] #
type Rep DkimAttributes Source #
Instance details Defined in Amazonka.PinpointEmail.Types.DkimAttributes type Rep DkimAttributes = D1 ('MetaData "DkimAttributes" "Amazonka.PinpointEmail.Types.DkimAttributes" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "DkimAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DkimStatus)) :: (S1 ('MetaSel ('Just "tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "signingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

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 Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:

PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.
SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity.
FAILED – Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.
TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain.
NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.

$sel:tokens:DkimAttributes', dkimAttributes_tokens - 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 Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.

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

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

Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:

PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.
SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity.
FAILED – Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.
TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain.
NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.

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

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 Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.

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

If the value is true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value is false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.