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.WAF.ListRateBasedRules

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.

This operation returns paginated results.

Creating a Request

data ListRateBasedRules Source #

See: newListRateBasedRules smart constructor.

Constructors

ListRateBasedRules'

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

newListRateBasedRules :: ListRateBasedRules Source #

Create a value of ListRateBasedRules 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:ListRateBasedRules', listRateBasedRules_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 ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

$sel:limit:ListRateBasedRules', listRateBasedRules_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

listRateBasedRules_nextMarker :: Lens' ListRateBasedRules (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 ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

listRateBasedRules_limit :: Lens' ListRateBasedRules (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 ListRateBasedRulesResponse Source #

See: newListRateBasedRulesResponse smart constructor.

Constructors

ListRateBasedRulesResponse'

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 ListRateBasedRules 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 ListRateBasedRulesResponse Source #
Instance details Defined in Amazonka.WAF.ListRateBasedRules Methods (==) :: ListRateBasedRulesResponse -> ListRateBasedRulesResponse -> Bool # (/=) :: ListRateBasedRulesResponse -> ListRateBasedRulesResponse -> Bool #
Read ListRateBasedRulesResponse Source #
Instance details Defined in Amazonka.WAF.ListRateBasedRules Methods readsPrec :: Int -> ReadS ListRateBasedRulesResponse # readList :: ReadS [ListRateBasedRulesResponse] # readPrec :: ReadPrec ListRateBasedRulesResponse # readListPrec :: ReadPrec [ListRateBasedRulesResponse] #
Show ListRateBasedRulesResponse Source #
Instance details Defined in Amazonka.WAF.ListRateBasedRules Methods showsPrec :: Int -> ListRateBasedRulesResponse -> ShowS # show :: ListRateBasedRulesResponse -> String # showList :: [ListRateBasedRulesResponse] -> ShowS #
Generic ListRateBasedRulesResponse Source #
Instance details Defined in Amazonka.WAF.ListRateBasedRules Associated Types type Rep ListRateBasedRulesResponse :: Type -> Type # Methods from :: ListRateBasedRulesResponse -> Rep ListRateBasedRulesResponse x # to :: Rep ListRateBasedRulesResponse x -> ListRateBasedRulesResponse #
NFData ListRateBasedRulesResponse Source #
Instance details Defined in Amazonka.WAF.ListRateBasedRules Methods rnf :: ListRateBasedRulesResponse -> () #
type Rep ListRateBasedRulesResponse Source #
Instance details Defined in Amazonka.WAF.ListRateBasedRules type Rep ListRateBasedRulesResponse = D1 ('MetaData "ListRateBasedRulesResponse" "Amazonka.WAF.ListRateBasedRules" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "ListRateBasedRulesResponse'" '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))))

newListRateBasedRulesResponse Source #

Arguments

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

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

$sel:nextMarker:ListRateBasedRules', listRateBasedRulesResponse_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 ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

$sel:httpStatus:ListRateBasedRulesResponse', listRateBasedRulesResponse_httpStatus - The response's http status code.

Response Lenses

listRateBasedRulesResponse_rules :: Lens' ListRateBasedRulesResponse (Maybe [RuleSummary]) Source #

An array of RuleSummary objects.

listRateBasedRulesResponse_nextMarker :: Lens' ListRateBasedRulesResponse (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 ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

listRateBasedRulesResponse_httpStatus :: Lens' ListRateBasedRulesResponse Int Source #

The response's http status code.