Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WAFRegional.ListRules

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 an array of RuleSummary objects.

Synopsis

data ListRules = ListRules' {
- nextMarker :: Maybe Text
- limit :: Maybe Natural
}
newListRules :: ListRules
listRules_nextMarker :: Lens' ListRules (Maybe Text)
listRules_limit :: Lens' ListRules (Maybe Natural)
data ListRulesResponse = ListRulesResponse' {
- rules :: Maybe [RuleSummary]
- nextMarker :: Maybe Text
- httpStatus :: Int
}
newListRulesResponse :: Int -> ListRulesResponse
listRulesResponse_rules :: Lens' ListRulesResponse (Maybe [RuleSummary])
listRulesResponse_nextMarker :: Lens' ListRulesResponse (Maybe Text)
listRulesResponse_httpStatus :: Lens' ListRulesResponse Int

Creating a Request

data ListRules Source #

See: newListRules smart constructor.

Constructors

ListRules'

Fields

nextMarker :: Maybe Text
If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.
limit :: Maybe Natural
Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

Instances

Instances details

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

newListRules :: ListRules Source #

Create a value of ListRules 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:nextMarker:ListRules', listRules_nextMarker - If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

$sel:limit:ListRules', listRules_limit - Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

Request Lenses

listRules_nextMarker :: Lens' ListRules (Maybe Text) Source #

If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

listRules_limit :: Lens' ListRules (Maybe Natural) Source #

Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

Destructuring the Response

data ListRulesResponse Source #

See: newListRulesResponse smart constructor.

Constructors

ListRulesResponse'

Fields

rules :: Maybe [RuleSummary]
An array of RuleSummary objects.
nextMarker :: Maybe Text
If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListRulesResponse Source #
Instance details Defined in Amazonka.WAFRegional.ListRules Methods (==) :: ListRulesResponse -> ListRulesResponse -> Bool # (/=) :: ListRulesResponse -> ListRulesResponse -> Bool #
Read ListRulesResponse Source #
Instance details Defined in Amazonka.WAFRegional.ListRules Methods readsPrec :: Int -> ReadS ListRulesResponse # readList :: ReadS [ListRulesResponse] # readPrec :: ReadPrec ListRulesResponse # readListPrec :: ReadPrec [ListRulesResponse] #
Show ListRulesResponse Source #
Instance details Defined in Amazonka.WAFRegional.ListRules Methods showsPrec :: Int -> ListRulesResponse -> ShowS # show :: ListRulesResponse -> String # showList :: [ListRulesResponse] -> ShowS #
Generic ListRulesResponse Source #
Instance details Defined in Amazonka.WAFRegional.ListRules Associated Types type Rep ListRulesResponse :: Type -> Type # Methods from :: ListRulesResponse -> Rep ListRulesResponse x # to :: Rep ListRulesResponse x -> ListRulesResponse #
NFData ListRulesResponse Source #
Instance details Defined in Amazonka.WAFRegional.ListRules Methods rnf :: ListRulesResponse -> () #
type Rep ListRulesResponse Source #
Instance details Defined in Amazonka.WAFRegional.ListRules type Rep ListRulesResponse = D1 ('MetaData "ListRulesResponse" "Amazonka.WAFRegional.ListRules" "libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional" 'False) (C1 ('MetaCons "ListRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RuleSummary])) :: (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRulesResponse Source #

Arguments

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

Create a value of ListRulesResponse 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:rules:ListRulesResponse', listRulesResponse_rules - An array of RuleSummary objects.

$sel:nextMarker:ListRules', listRulesResponse_nextMarker - If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

$sel:httpStatus:ListRulesResponse', listRulesResponse_httpStatus - The response's http status code.

Response Lenses

listRulesResponse_rules :: Lens' ListRulesResponse (Maybe [RuleSummary]) Source #

An array of RuleSummary objects.

listRulesResponse_nextMarker :: Lens' ListRulesResponse (Maybe Text) Source #

If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

listRulesResponse_httpStatus :: Lens' ListRulesResponse Int Source #

The response's http status code.