amazonka-ses-2.0: Amazon Simple Email Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SES.SetActiveReceiptRuleSet

Description

Sets the specified receipt rule set as the active receipt rule set.

To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

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

Synopsis

Creating a Request

data SetActiveReceiptRuleSet Source #

Represents a request to set a receipt rule set as the active receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

See: newSetActiveReceiptRuleSet smart constructor.

Constructors

SetActiveReceiptRuleSet' 

Fields

  • ruleSetName :: Maybe Text

    The name of the receipt rule set to make active. Setting this value to null disables all email receiving.

Instances

Instances details
ToHeaders SetActiveReceiptRuleSet Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

ToPath SetActiveReceiptRuleSet Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

ToQuery SetActiveReceiptRuleSet Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

AWSRequest SetActiveReceiptRuleSet Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

Generic SetActiveReceiptRuleSet Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

Associated Types

type Rep SetActiveReceiptRuleSet :: Type -> Type #

Read SetActiveReceiptRuleSet Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

Show SetActiveReceiptRuleSet Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

NFData SetActiveReceiptRuleSet Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

Methods

rnf :: SetActiveReceiptRuleSet -> () #

Eq SetActiveReceiptRuleSet Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

Hashable SetActiveReceiptRuleSet Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

type AWSResponse SetActiveReceiptRuleSet Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

type Rep SetActiveReceiptRuleSet Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

type Rep SetActiveReceiptRuleSet = D1 ('MetaData "SetActiveReceiptRuleSet" "Amazonka.SES.SetActiveReceiptRuleSet" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "SetActiveReceiptRuleSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newSetActiveReceiptRuleSet :: SetActiveReceiptRuleSet Source #

Create a value of SetActiveReceiptRuleSet 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:ruleSetName:SetActiveReceiptRuleSet', setActiveReceiptRuleSet_ruleSetName - The name of the receipt rule set to make active. Setting this value to null disables all email receiving.

Request Lenses

setActiveReceiptRuleSet_ruleSetName :: Lens' SetActiveReceiptRuleSet (Maybe Text) Source #

The name of the receipt rule set to make active. Setting this value to null disables all email receiving.

Destructuring the Response

data SetActiveReceiptRuleSetResponse Source #

An empty element returned on a successful request.

See: newSetActiveReceiptRuleSetResponse smart constructor.

Constructors

SetActiveReceiptRuleSetResponse' 

Fields

Instances

Instances details
Generic SetActiveReceiptRuleSetResponse Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

Associated Types

type Rep SetActiveReceiptRuleSetResponse :: Type -> Type #

Read SetActiveReceiptRuleSetResponse Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

Show SetActiveReceiptRuleSetResponse Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

NFData SetActiveReceiptRuleSetResponse Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

Eq SetActiveReceiptRuleSetResponse Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

type Rep SetActiveReceiptRuleSetResponse Source # 
Instance details

Defined in Amazonka.SES.SetActiveReceiptRuleSet

type Rep SetActiveReceiptRuleSetResponse = D1 ('MetaData "SetActiveReceiptRuleSetResponse" "Amazonka.SES.SetActiveReceiptRuleSet" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "SetActiveReceiptRuleSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSetActiveReceiptRuleSetResponse Source #

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

Response Lenses