Amazonka.WAF.GetRule

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.

Creating a Request

data GetRule

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

ToJSON GetRule

Defined in Amazonka.WAF.GetRule

Methods

toJSON :: GetRule -> Value

toEncoding :: GetRule -> Encoding

toJSONList :: [GetRule] -> Value

toEncodingList :: [GetRule] -> Encoding

ToHeaders GetRule

Defined in Amazonka.WAF.GetRule

Methods

toHeaders :: GetRule -> [Header]

ToPath GetRule

Defined in Amazonka.WAF.GetRule

Methods

toPath :: GetRule -> ByteString

ToQuery GetRule

Defined in Amazonka.WAF.GetRule

Methods

toQuery :: GetRule -> QueryString

AWSRequest GetRule

Defined in Amazonka.WAF.GetRule

Associated Types

type AWSResponse GetRule

Methods

request :: (Service -> Service) -> GetRule -> Request GetRule

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

Generic GetRule

Defined in Amazonka.WAF.GetRule

Associated Types

type Rep GetRule :: Type -> Type

Methods

from :: GetRule -> Rep GetRule x

to :: Rep GetRule x -> GetRule

Read GetRule

Defined in Amazonka.WAF.GetRule

Methods

readsPrec :: Int -> ReadS GetRule

readList :: ReadS [GetRule]

readPrec :: ReadPrec GetRule

readListPrec :: ReadPrec [GetRule]

Show GetRule

Defined in Amazonka.WAF.GetRule

Methods

showsPrec :: Int -> GetRule -> ShowS

show :: GetRule -> String

showList :: [GetRule] -> ShowS

NFData GetRule

Defined in Amazonka.WAF.GetRule

Methods

rnf :: GetRule -> ()

Eq GetRule

Defined in Amazonka.WAF.GetRule

Methods

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

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

Hashable GetRule

Defined in Amazonka.WAF.GetRule

Methods

hashWithSalt :: Int -> GetRule -> Int

hash :: GetRule -> Int

type AWSResponse GetRule

Defined in Amazonka.WAF.GetRule

type AWSResponse GetRule = GetRuleResponse

type Rep GetRule

Defined in Amazonka.WAF.GetRule

type Rep GetRule = D1 ('MetaData "GetRule" "Amazonka.WAF.GetRule" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" 'False) (C1 ('MetaCons "GetRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetRule

Arguments

:: Text

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:

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

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

Destructuring the Response

data GetRuleResponse

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

Generic GetRuleResponse

Defined in Amazonka.WAF.GetRule

Associated Types

type Rep GetRuleResponse :: Type -> Type

Methods

from :: GetRuleResponse -> Rep GetRuleResponse x

to :: Rep GetRuleResponse x -> GetRuleResponse

Read GetRuleResponse

Defined in Amazonka.WAF.GetRule

Methods

readsPrec :: Int -> ReadS GetRuleResponse

readList :: ReadS [GetRuleResponse]

readPrec :: ReadPrec GetRuleResponse

readListPrec :: ReadPrec [GetRuleResponse]

Show GetRuleResponse

Defined in Amazonka.WAF.GetRule

Methods

showsPrec :: Int -> GetRuleResponse -> ShowS

show :: GetRuleResponse -> String

showList :: [GetRuleResponse] -> ShowS

NFData GetRuleResponse

Defined in Amazonka.WAF.GetRule

Methods

rnf :: GetRuleResponse -> ()

Eq GetRuleResponse

Defined in Amazonka.WAF.GetRule

Methods

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

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

type Rep GetRuleResponse

Defined in Amazonka.WAF.GetRule

type Rep GetRuleResponse = D1 ('MetaData "GetRuleResponse" "Amazonka.WAF.GetRule" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" '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

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)

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

The response's http status code.