libZSservicesZSamazonka-sesZSamazonka-ses
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SES.SetIdentityDkimEnabled

Description

Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address.

For email addresses (for example, user@example.com), you can only enable DKIM signing if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM.

You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete.

You can execute this operation no more than once per second.

For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

Synopsis

Creating a Request

data SetIdentityDkimEnabled Source #

Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.

See: newSetIdentityDkimEnabled smart constructor.

Constructors

SetIdentityDkimEnabled' 

Fields

  • identity :: Text

    The identity for which DKIM signing should be enabled or disabled.

  • dkimEnabled :: Bool

    Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.

Instances

Instances details
Eq SetIdentityDkimEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

Read SetIdentityDkimEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

Show SetIdentityDkimEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

Generic SetIdentityDkimEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

Associated Types

type Rep SetIdentityDkimEnabled :: Type -> Type #

NFData SetIdentityDkimEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

Methods

rnf :: SetIdentityDkimEnabled -> () #

Hashable SetIdentityDkimEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

AWSRequest SetIdentityDkimEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

Associated Types

type AWSResponse SetIdentityDkimEnabled #

ToHeaders SetIdentityDkimEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

ToPath SetIdentityDkimEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

ToQuery SetIdentityDkimEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

type Rep SetIdentityDkimEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

type Rep SetIdentityDkimEnabled = D1 ('MetaData "SetIdentityDkimEnabled" "Amazonka.SES.SetIdentityDkimEnabled" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "SetIdentityDkimEnabled'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dkimEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))
type AWSResponse SetIdentityDkimEnabled Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

newSetIdentityDkimEnabled Source #

Create a value of SetIdentityDkimEnabled 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:identity:SetIdentityDkimEnabled', setIdentityDkimEnabled_identity - The identity for which DKIM signing should be enabled or disabled.

$sel:dkimEnabled:SetIdentityDkimEnabled', setIdentityDkimEnabled_dkimEnabled - Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.

Request Lenses

setIdentityDkimEnabled_identity :: Lens' SetIdentityDkimEnabled Text Source #

The identity for which DKIM signing should be enabled or disabled.

setIdentityDkimEnabled_dkimEnabled :: Lens' SetIdentityDkimEnabled Bool Source #

Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.

Destructuring the Response

data SetIdentityDkimEnabledResponse Source #

An empty element returned on a successful request.

See: newSetIdentityDkimEnabledResponse smart constructor.

Constructors

SetIdentityDkimEnabledResponse' 

Fields

Instances

Instances details
Eq SetIdentityDkimEnabledResponse Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

Read SetIdentityDkimEnabledResponse Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

Show SetIdentityDkimEnabledResponse Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

Generic SetIdentityDkimEnabledResponse Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

Associated Types

type Rep SetIdentityDkimEnabledResponse :: Type -> Type #

NFData SetIdentityDkimEnabledResponse Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

type Rep SetIdentityDkimEnabledResponse Source # 
Instance details

Defined in Amazonka.SES.SetIdentityDkimEnabled

type Rep SetIdentityDkimEnabledResponse = D1 ('MetaData "SetIdentityDkimEnabledResponse" "Amazonka.SES.SetIdentityDkimEnabled" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "SetIdentityDkimEnabledResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSetIdentityDkimEnabledResponse Source #

Create a value of SetIdentityDkimEnabledResponse 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:httpStatus:SetIdentityDkimEnabledResponse', setIdentityDkimEnabledResponse_httpStatus - The response's http status code.

Response Lenses