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.PutEmailIdentityDkimSigningAttributes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following:

Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).
Update the key length that should be used for Easy DKIM.
Change from using no DKIM authentication to using Easy DKIM.
Change from using no DKIM authentication to using BYODKIM.
Change from using Easy DKIM to using BYODKIM.
Change from using BYODKIM to using Easy DKIM.

Synopsis

Creating a Request

data PutEmailIdentityDkimSigningAttributes Source #

A request to change the DKIM attributes for an email identity.

See: newPutEmailIdentityDkimSigningAttributes smart constructor.

Constructors

PutEmailIdentityDkimSigningAttributes'

Fields

signingAttributes :: Maybe DkimSigningAttributes
An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
emailIdentity :: Text
The email identity.
signingAttributesOrigin :: DkimSigningAttributesOrigin
The method to use to configure DKIM for the identity. There are the following possible values:
- AWS_SES – Configure DKIM for the identity by using Easy DKIM.
- EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

Instances

Instances details

Eq PutEmailIdentityDkimSigningAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Methods (==) :: PutEmailIdentityDkimSigningAttributes -> PutEmailIdentityDkimSigningAttributes -> Bool # (/=) :: PutEmailIdentityDkimSigningAttributes -> PutEmailIdentityDkimSigningAttributes -> Bool #
Show PutEmailIdentityDkimSigningAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Methods showsPrec :: Int -> PutEmailIdentityDkimSigningAttributes -> ShowS # show :: PutEmailIdentityDkimSigningAttributes -> String # showList :: [PutEmailIdentityDkimSigningAttributes] -> ShowS #
Generic PutEmailIdentityDkimSigningAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Associated Types type Rep PutEmailIdentityDkimSigningAttributes :: Type -> Type # Methods from :: PutEmailIdentityDkimSigningAttributes -> Rep PutEmailIdentityDkimSigningAttributes x # to :: Rep PutEmailIdentityDkimSigningAttributes x -> PutEmailIdentityDkimSigningAttributes #
NFData PutEmailIdentityDkimSigningAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Methods rnf :: PutEmailIdentityDkimSigningAttributes -> () #
Hashable PutEmailIdentityDkimSigningAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Methods hashWithSalt :: Int -> PutEmailIdentityDkimSigningAttributes -> Int # hash :: PutEmailIdentityDkimSigningAttributes -> Int #
ToJSON PutEmailIdentityDkimSigningAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Methods toJSON :: PutEmailIdentityDkimSigningAttributes -> Value # toEncoding :: PutEmailIdentityDkimSigningAttributes -> Encoding # toJSONList :: [PutEmailIdentityDkimSigningAttributes] -> Value # toEncodingList :: [PutEmailIdentityDkimSigningAttributes] -> Encoding #
AWSRequest PutEmailIdentityDkimSigningAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Associated Types type AWSResponse PutEmailIdentityDkimSigningAttributes # Methods request :: PutEmailIdentityDkimSigningAttributes -> Request PutEmailIdentityDkimSigningAttributes # response :: MonadResource m => Logger -> Service -> Proxy PutEmailIdentityDkimSigningAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutEmailIdentityDkimSigningAttributes))) #
ToHeaders PutEmailIdentityDkimSigningAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Methods toHeaders :: PutEmailIdentityDkimSigningAttributes -> [Header] #
ToPath PutEmailIdentityDkimSigningAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Methods toPath :: PutEmailIdentityDkimSigningAttributes -> ByteString #
ToQuery PutEmailIdentityDkimSigningAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Methods toQuery :: PutEmailIdentityDkimSigningAttributes -> QueryString #
type Rep PutEmailIdentityDkimSigningAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes type Rep PutEmailIdentityDkimSigningAttributes = D1 ('MetaData "PutEmailIdentityDkimSigningAttributes" "Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes" "libZSservicesZSamazonka-sesv2ZSamazonka-sesv2" 'False) (C1 ('MetaCons "PutEmailIdentityDkimSigningAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "signingAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DkimSigningAttributes)) :: (S1 ('MetaSel ('Just "emailIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "signingAttributesOrigin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DkimSigningAttributesOrigin))))
type AWSResponse PutEmailIdentityDkimSigningAttributes Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes type AWSResponse PutEmailIdentityDkimSigningAttributes = PutEmailIdentityDkimSigningAttributesResponse

newPutEmailIdentityDkimSigningAttributes Source #

Arguments

:: Text	`$sel:emailIdentity:PutEmailIdentityDkimSigningAttributes'`
-> DkimSigningAttributesOrigin	`$sel:signingAttributesOrigin:PutEmailIdentityDkimSigningAttributes'`
-> PutEmailIdentityDkimSigningAttributes

Create a value of PutEmailIdentityDkimSigningAttributes 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:signingAttributes:PutEmailIdentityDkimSigningAttributes', putEmailIdentityDkimSigningAttributes_signingAttributes - An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.

$sel:emailIdentity:PutEmailIdentityDkimSigningAttributes', putEmailIdentityDkimSigningAttributes_emailIdentity - The email identity.

$sel:signingAttributesOrigin:PutEmailIdentityDkimSigningAttributes', putEmailIdentityDkimSigningAttributes_signingAttributesOrigin - The method to use to configure DKIM for the identity. There are the following possible values:

AWS_SES – Configure DKIM for the identity by using Easy DKIM.
EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

Request Lenses

putEmailIdentityDkimSigningAttributes_signingAttributes :: Lens' PutEmailIdentityDkimSigningAttributes (Maybe DkimSigningAttributes) Source #

An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.

putEmailIdentityDkimSigningAttributes_emailIdentity :: Lens' PutEmailIdentityDkimSigningAttributes Text Source #

The email identity.

putEmailIdentityDkimSigningAttributes_signingAttributesOrigin :: Lens' PutEmailIdentityDkimSigningAttributes DkimSigningAttributesOrigin Source #

The method to use to configure DKIM for the identity. There are the following possible values:

AWS_SES – Configure DKIM for the identity by using Easy DKIM.
EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

Destructuring the Response

data PutEmailIdentityDkimSigningAttributesResponse Source #

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: newPutEmailIdentityDkimSigningAttributesResponse smart constructor.

Constructors

PutEmailIdentityDkimSigningAttributesResponse'

Fields

dkimStatus :: Maybe 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.
dkimTokens :: 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 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq PutEmailIdentityDkimSigningAttributesResponse Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Methods (==) :: PutEmailIdentityDkimSigningAttributesResponse -> PutEmailIdentityDkimSigningAttributesResponse -> Bool # (/=) :: PutEmailIdentityDkimSigningAttributesResponse -> PutEmailIdentityDkimSigningAttributesResponse -> Bool #
Read PutEmailIdentityDkimSigningAttributesResponse Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Methods readsPrec :: Int -> ReadS PutEmailIdentityDkimSigningAttributesResponse # readList :: ReadS [PutEmailIdentityDkimSigningAttributesResponse] # readPrec :: ReadPrec PutEmailIdentityDkimSigningAttributesResponse # readListPrec :: ReadPrec [PutEmailIdentityDkimSigningAttributesResponse] #
Show PutEmailIdentityDkimSigningAttributesResponse Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Methods showsPrec :: Int -> PutEmailIdentityDkimSigningAttributesResponse -> ShowS # show :: PutEmailIdentityDkimSigningAttributesResponse -> String # showList :: [PutEmailIdentityDkimSigningAttributesResponse] -> ShowS #
Generic PutEmailIdentityDkimSigningAttributesResponse Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Associated Types type Rep PutEmailIdentityDkimSigningAttributesResponse :: Type -> Type # Methods from :: PutEmailIdentityDkimSigningAttributesResponse -> Rep PutEmailIdentityDkimSigningAttributesResponse x # to :: Rep PutEmailIdentityDkimSigningAttributesResponse x -> PutEmailIdentityDkimSigningAttributesResponse #
NFData PutEmailIdentityDkimSigningAttributesResponse Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes Methods rnf :: PutEmailIdentityDkimSigningAttributesResponse -> () #
type Rep PutEmailIdentityDkimSigningAttributesResponse Source #
Instance details Defined in Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes type Rep PutEmailIdentityDkimSigningAttributesResponse = D1 ('MetaData "PutEmailIdentityDkimSigningAttributesResponse" "Amazonka.SESV2.PutEmailIdentityDkimSigningAttributes" "libZSservicesZSamazonka-sesv2ZSamazonka-sesv2" 'False) (C1 ('MetaCons "PutEmailIdentityDkimSigningAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dkimStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DkimStatus)) :: (S1 ('MetaSel ('Just "dkimTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newPutEmailIdentityDkimSigningAttributesResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutEmailIdentityDkimSigningAttributesResponse'`
-> PutEmailIdentityDkimSigningAttributesResponse

Create a value of PutEmailIdentityDkimSigningAttributesResponse 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:dkimStatus:PutEmailIdentityDkimSigningAttributesResponse', putEmailIdentityDkimSigningAttributesResponse_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.

$sel:dkimTokens:PutEmailIdentityDkimSigningAttributesResponse', putEmailIdentityDkimSigningAttributesResponse_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.

$sel:httpStatus:PutEmailIdentityDkimSigningAttributesResponse', putEmailIdentityDkimSigningAttributesResponse_httpStatus - The response's http status code.

Response Lenses

putEmailIdentityDkimSigningAttributesResponse_dkimStatus :: Lens' PutEmailIdentityDkimSigningAttributesResponse (Maybe DkimStatus) Source #

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.

putEmailIdentityDkimSigningAttributesResponse_dkimTokens :: Lens' PutEmailIdentityDkimSigningAttributesResponse (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 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.

putEmailIdentityDkimSigningAttributesResponse_httpStatus :: Lens' PutEmailIdentityDkimSigningAttributesResponse Int Source #

The response's http status code.