Amazonka.WAFRegional.ListRateBasedRules

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.

Creating a Request

data ListRateBasedRules

See: newListRateBasedRules smart constructor.

Constructors

ListRateBasedRules'

Fields

• 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.

• 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.

Instances

ToJSON ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

toJSON :: ListRateBasedRules -> Value

toEncoding :: ListRateBasedRules -> Encoding

toJSONList :: [ListRateBasedRules] -> Value

toEncodingList :: [ListRateBasedRules] -> Encoding

ToHeaders ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

toHeaders :: ListRateBasedRules -> [Header]

ToPath ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

toPath :: ListRateBasedRules -> ByteString

ToQuery ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

toQuery :: ListRateBasedRules -> QueryString

AWSRequest ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

Associated Types

type AWSResponse ListRateBasedRules

Methods

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

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

Generic ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

Associated Types

type Rep ListRateBasedRules :: Type -> Type

Methods

from :: ListRateBasedRules -> Rep ListRateBasedRules x

to :: Rep ListRateBasedRules x -> ListRateBasedRules

Read ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

readsPrec :: Int -> ReadS ListRateBasedRules

readList :: ReadS [ListRateBasedRules]

readPrec :: ReadPrec ListRateBasedRules

readListPrec :: ReadPrec [ListRateBasedRules]

Show ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

showsPrec :: Int -> ListRateBasedRules -> ShowS

show :: ListRateBasedRules -> String

showList :: [ListRateBasedRules] -> ShowS

NFData ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

rnf :: ListRateBasedRules -> ()

Eq ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

(==) :: ListRateBasedRules -> ListRateBasedRules -> Bool

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

Hashable ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

hashWithSalt :: Int -> ListRateBasedRules -> Int

hash :: ListRateBasedRules -> Int

type AWSResponse ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

type AWSResponse ListRateBasedRules = ListRateBasedRulesResponse

type Rep ListRateBasedRules

Defined in Amazonka.WAFRegional.ListRateBasedRules

type Rep ListRateBasedRules = D1 ('MetaData "ListRateBasedRules" "Amazonka.WAFRegional.ListRateBasedRules" "amazonka-waf-regional-2.0-83dY3vKOuQzAAW7M6EmzRI" 'False) (C1 ('MetaCons "ListRateBasedRules'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListRateBasedRules :: ListRateBasedRules

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: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.

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.

Request Lenses

listRateBasedRules_limit :: Lens' ListRateBasedRules (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.

listRateBasedRules_nextMarker :: Lens' ListRateBasedRules (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.

Destructuring the Response

data ListRateBasedRulesResponse

See: newListRateBasedRulesResponse smart constructor.

Constructors

ListRateBasedRulesResponse'

Fields

• 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.

• rules :: Maybe [RuleSummary]

  An array of RuleSummary objects.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListRateBasedRulesResponse

Defined in Amazonka.WAFRegional.ListRateBasedRules

Associated Types

type Rep ListRateBasedRulesResponse :: Type -> Type

Methods

from :: ListRateBasedRulesResponse -> Rep ListRateBasedRulesResponse x

to :: Rep ListRateBasedRulesResponse x -> ListRateBasedRulesResponse

Read ListRateBasedRulesResponse

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

readsPrec :: Int -> ReadS ListRateBasedRulesResponse

readList :: ReadS [ListRateBasedRulesResponse]

readPrec :: ReadPrec ListRateBasedRulesResponse

readListPrec :: ReadPrec [ListRateBasedRulesResponse]

Show ListRateBasedRulesResponse

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

showsPrec :: Int -> ListRateBasedRulesResponse -> ShowS

show :: ListRateBasedRulesResponse -> String

showList :: [ListRateBasedRulesResponse] -> ShowS

NFData ListRateBasedRulesResponse

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

rnf :: ListRateBasedRulesResponse -> ()

Eq ListRateBasedRulesResponse

Defined in Amazonka.WAFRegional.ListRateBasedRules

Methods

(==) :: ListRateBasedRulesResponse -> ListRateBasedRulesResponse -> Bool

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

type Rep ListRateBasedRulesResponse

Defined in Amazonka.WAFRegional.ListRateBasedRules

type Rep ListRateBasedRulesResponse = D1 ('MetaData "ListRateBasedRulesResponse" "Amazonka.WAFRegional.ListRateBasedRules" "amazonka-waf-regional-2.0-83dY3vKOuQzAAW7M6EmzRI" 'False) (C1 ('MetaCons "ListRateBasedRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RuleSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRateBasedRulesResponse

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:

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.

ListRateBasedRulesResponse, listRateBasedRulesResponse_rules - An array of RuleSummary objects.

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

Response Lenses

listRateBasedRulesResponse_nextMarker :: Lens' ListRateBasedRulesResponse (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.

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

An array of RuleSummary objects.

listRateBasedRulesResponse_httpStatus :: Lens' ListRateBasedRulesResponse Int

The response's http status code.