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

Description

Returns the details of the specified receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

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

Synopsis

Creating a Request

data DescribeReceiptRule Source #

Represents a request to return the details of a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

See: newDescribeReceiptRule smart constructor.

Constructors

DescribeReceiptRule' 

Fields

Instances

Instances details
Eq DescribeReceiptRule Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

Read DescribeReceiptRule Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

Show DescribeReceiptRule Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

Generic DescribeReceiptRule Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

Associated Types

type Rep DescribeReceiptRule :: Type -> Type #

NFData DescribeReceiptRule Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

Methods

rnf :: DescribeReceiptRule -> () #

Hashable DescribeReceiptRule Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

AWSRequest DescribeReceiptRule Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

Associated Types

type AWSResponse DescribeReceiptRule #

ToHeaders DescribeReceiptRule Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

ToPath DescribeReceiptRule Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

ToQuery DescribeReceiptRule Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

type Rep DescribeReceiptRule Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

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

Defined in Amazonka.SES.DescribeReceiptRule

newDescribeReceiptRule Source #

Create a value of DescribeReceiptRule 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:DescribeReceiptRule', describeReceiptRule_ruleSetName - The name of the receipt rule set that the receipt rule belongs to.

$sel:ruleName:DescribeReceiptRule', describeReceiptRule_ruleName - The name of the receipt rule.

Request Lenses

describeReceiptRule_ruleSetName :: Lens' DescribeReceiptRule Text Source #

The name of the receipt rule set that the receipt rule belongs to.

Destructuring the Response

data DescribeReceiptRuleResponse Source #

Represents the details of a receipt rule.

See: newDescribeReceiptRuleResponse smart constructor.

Constructors

DescribeReceiptRuleResponse' 

Fields

  • rule :: Maybe ReceiptRule

    A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeReceiptRuleResponse Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

Read DescribeReceiptRuleResponse Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

Show DescribeReceiptRuleResponse Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

Generic DescribeReceiptRuleResponse Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

Associated Types

type Rep DescribeReceiptRuleResponse :: Type -> Type #

NFData DescribeReceiptRuleResponse Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

type Rep DescribeReceiptRuleResponse Source # 
Instance details

Defined in Amazonka.SES.DescribeReceiptRule

type Rep DescribeReceiptRuleResponse = D1 ('MetaData "DescribeReceiptRuleResponse" "Amazonka.SES.DescribeReceiptRule" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "DescribeReceiptRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReceiptRule)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeReceiptRuleResponse Source #

Create a value of DescribeReceiptRuleResponse 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:rule:DescribeReceiptRuleResponse', describeReceiptRuleResponse_rule - A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.

$sel:httpStatus:DescribeReceiptRuleResponse', describeReceiptRuleResponse_httpStatus - The response's http status code.

Response Lenses

describeReceiptRuleResponse_rule :: Lens' DescribeReceiptRuleResponse (Maybe ReceiptRule) Source #

A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.