libZSservicesZSamazonka-wafZSamazonka-waf
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.WAF.GetRule

Description

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the Rule that is specified by the RuleId that you included in the GetRule request.

Synopsis

Creating a Request

data GetRule Source #

See: newGetRule smart constructor.

Constructors

GetRule' 

Fields

  • ruleId :: Text

    The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.

Instances

Instances details
Eq GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

(==) :: GetRule -> GetRule -> Bool #

(/=) :: GetRule -> GetRule -> Bool #

Read GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

readsPrec :: Int -> ReadS GetRule #

readList :: ReadS [GetRule] #

readPrec :: ReadPrec GetRule #

readListPrec :: ReadPrec [GetRule] #

Show GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

showsPrec :: Int -> GetRule -> ShowS #

show :: GetRule -> String #

showList :: [GetRule] -> ShowS #

Generic GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Associated Types

type Rep GetRule :: Type -> Type #

Methods

from :: GetRule -> Rep GetRule x #

to :: Rep GetRule x -> GetRule #

NFData GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

rnf :: GetRule -> () #

Hashable GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

hashWithSalt :: Int -> GetRule -> Int #

hash :: GetRule -> Int #

ToJSON GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

toJSON :: GetRule -> Value #

toEncoding :: GetRule -> Encoding #

toJSONList :: [GetRule] -> Value #

toEncodingList :: [GetRule] -> Encoding #

AWSRequest GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Associated Types

type AWSResponse GetRule #

Methods

request :: GetRule -> Request GetRule #

response :: MonadResource m => Logger -> Service -> Proxy GetRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRule))) #

ToHeaders GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

toHeaders :: GetRule -> [Header] #

ToPath GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

toPath :: GetRule -> ByteString #

ToQuery GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

toQuery :: GetRule -> QueryString #

type Rep GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

type Rep GetRule = D1 ('MetaData "GetRule" "Amazonka.WAF.GetRule" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "GetRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetRule Source # 
Instance details

Defined in Amazonka.WAF.GetRule

type AWSResponse GetRule = GetRuleResponse

newGetRule Source #

Arguments

:: Text

$sel:ruleId:GetRule'

-> GetRule 

Create a value of GetRule 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:ruleId:GetRule', getRule_ruleId - The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.

Request Lenses

getRule_ruleId :: Lens' GetRule Text Source #

The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.

Destructuring the Response

data GetRuleResponse Source #

See: newGetRuleResponse smart constructor.

Constructors

GetRuleResponse' 

Fields

  • rule :: Maybe Rule

    Information about the Rule that you specified in the GetRule request. For more information, see the following topics:

    • Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId
    • Predicate: Each Predicate object contains DataId, Negated, and Type
  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetRuleResponse Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

(==) :: GetRuleResponse -> GetRuleResponse -> Bool #

(/=) :: GetRuleResponse -> GetRuleResponse -> Bool #

Read GetRuleResponse Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

readsPrec :: Int -> ReadS GetRuleResponse #

readList :: ReadS [GetRuleResponse] #

readPrec :: ReadPrec GetRuleResponse #

readListPrec :: ReadPrec [GetRuleResponse] #

Show GetRuleResponse Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

showsPrec :: Int -> GetRuleResponse -> ShowS #

show :: GetRuleResponse -> String #

showList :: [GetRuleResponse] -> ShowS #

Generic GetRuleResponse Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Associated Types

type Rep GetRuleResponse :: Type -> Type #

Methods

from :: GetRuleResponse -> Rep GetRuleResponse x #

to :: Rep GetRuleResponse x -> GetRuleResponse #

NFData GetRuleResponse Source # 
Instance details

Defined in Amazonka.WAF.GetRule

Methods

rnf :: GetRuleResponse -> () #

type Rep GetRuleResponse Source # 
Instance details

Defined in Amazonka.WAF.GetRule

type Rep GetRuleResponse = D1 ('MetaData "GetRuleResponse" "Amazonka.WAF.GetRule" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "GetRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Rule)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetRuleResponse Source #

Arguments

:: Int

$sel:httpStatus:GetRuleResponse'

-> GetRuleResponse 

Create a value of GetRuleResponse 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:GetRuleResponse', getRuleResponse_rule - Information about the Rule that you specified in the GetRule request. For more information, see the following topics:

  • Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId
  • Predicate: Each Predicate object contains DataId, Negated, and Type

$sel:httpStatus:GetRuleResponse', getRuleResponse_httpStatus - The response's http status code.

Response Lenses

getRuleResponse_rule :: Lens' GetRuleResponse (Maybe Rule) Source #

Information about the Rule that you specified in the GetRule request. For more information, see the following topics:

  • Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId
  • Predicate: Each Predicate object contains DataId, Negated, and Type

getRuleResponse_httpStatus :: Lens' GetRuleResponse Int Source #

The response's http status code.