Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WAFRegional.GetRuleGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request.

To view the rules in a rule group, use ListActivatedRulesInRuleGroup.

Synopsis

Creating a Request

data GetRuleGroup Source #

See: newGetRuleGroup smart constructor.

Constructors

GetRuleGroup'
Fields ruleGroupId :: Text The `RuleGroupId` of the RuleGroup that you want to get. `RuleGroupId` is returned by CreateRuleGroup and by ListRuleGroups.

Instances

Instances details

ToJSON GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods toJSON :: GetRuleGroup -> Value # toEncoding :: GetRuleGroup -> Encoding # toJSONList :: [GetRuleGroup] -> Value # toEncodingList :: [GetRuleGroup] -> Encoding #
ToHeaders GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods toHeaders :: GetRuleGroup -> [Header] #
ToPath GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods toPath :: GetRuleGroup -> ByteString #
ToQuery GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods toQuery :: GetRuleGroup -> QueryString #
AWSRequest GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Associated Types type AWSResponse GetRuleGroup # Methods request :: (Service -> Service) -> GetRuleGroup -> Request GetRuleGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRuleGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRuleGroup))) #
Generic GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Associated Types type Rep GetRuleGroup :: Type -> Type # Methods from :: GetRuleGroup -> Rep GetRuleGroup x # to :: Rep GetRuleGroup x -> GetRuleGroup #
Read GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods readsPrec :: Int -> ReadS GetRuleGroup # readList :: ReadS [GetRuleGroup] # readPrec :: ReadPrec GetRuleGroup # readListPrec :: ReadPrec [GetRuleGroup] #
Show GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods showsPrec :: Int -> GetRuleGroup -> ShowS # show :: GetRuleGroup -> String # showList :: [GetRuleGroup] -> ShowS #
NFData GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods rnf :: GetRuleGroup -> () #
Eq GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods (==) :: GetRuleGroup -> GetRuleGroup -> Bool # (/=) :: GetRuleGroup -> GetRuleGroup -> Bool #
Hashable GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods hashWithSalt :: Int -> GetRuleGroup -> Int # hash :: GetRuleGroup -> Int #
type AWSResponse GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup type AWSResponse GetRuleGroup = GetRuleGroupResponse
type Rep GetRuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup type Rep GetRuleGroup = D1 ('MetaData "GetRuleGroup" "Amazonka.WAFRegional.GetRuleGroup" "amazonka-waf-regional-2.0-83dY3vKOuQzAAW7M6EmzRI" 'False) (C1 ('MetaCons "GetRuleGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetRuleGroup Source #

Arguments

:: Text	`GetRuleGroup`
-> GetRuleGroup

Create a value of GetRuleGroup 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:

GetRuleGroup, getRuleGroup_ruleGroupId - The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Request Lenses

getRuleGroup_ruleGroupId :: Lens' GetRuleGroup Text Source #

The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Destructuring the Response

data GetRuleGroupResponse Source #

See: newGetRuleGroupResponse smart constructor.

Constructors

GetRuleGroupResponse'
Fields ruleGroup :: Maybe RuleGroup Information about the RuleGroup that you specified in the `GetRuleGroup` request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetRuleGroupResponse Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Associated Types type Rep GetRuleGroupResponse :: Type -> Type # Methods from :: GetRuleGroupResponse -> Rep GetRuleGroupResponse x # to :: Rep GetRuleGroupResponse x -> GetRuleGroupResponse #
Read GetRuleGroupResponse Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods readsPrec :: Int -> ReadS GetRuleGroupResponse # readList :: ReadS [GetRuleGroupResponse] # readPrec :: ReadPrec GetRuleGroupResponse # readListPrec :: ReadPrec [GetRuleGroupResponse] #
Show GetRuleGroupResponse Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods showsPrec :: Int -> GetRuleGroupResponse -> ShowS # show :: GetRuleGroupResponse -> String # showList :: [GetRuleGroupResponse] -> ShowS #
NFData GetRuleGroupResponse Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods rnf :: GetRuleGroupResponse -> () #
Eq GetRuleGroupResponse Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup Methods (==) :: GetRuleGroupResponse -> GetRuleGroupResponse -> Bool # (/=) :: GetRuleGroupResponse -> GetRuleGroupResponse -> Bool #
type Rep GetRuleGroupResponse Source #
Instance details Defined in Amazonka.WAFRegional.GetRuleGroup type Rep GetRuleGroupResponse = D1 ('MetaData "GetRuleGroupResponse" "Amazonka.WAFRegional.GetRuleGroup" "amazonka-waf-regional-2.0-83dY3vKOuQzAAW7M6EmzRI" 'False) (C1 ('MetaCons "GetRuleGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetRuleGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetRuleGroupResponse'`
-> GetRuleGroupResponse

Create a value of GetRuleGroupResponse 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:ruleGroup:GetRuleGroupResponse', getRuleGroupResponse_ruleGroup - Information about the RuleGroup that you specified in the GetRuleGroup request.

$sel:httpStatus:GetRuleGroupResponse', getRuleGroupResponse_httpStatus - The response's http status code.

Response Lenses

getRuleGroupResponse_ruleGroup :: Lens' GetRuleGroupResponse (Maybe RuleGroup) Source #

Information about the RuleGroup that you specified in the GetRuleGroup request.

getRuleGroupResponse_httpStatus :: Lens' GetRuleGroupResponse Int Source #

The response's http status code.