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 |
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 RuleGroup objects.
This operation returns paginated results.
Synopsis
- data ListRuleGroups = ListRuleGroups' {}
- newListRuleGroups :: ListRuleGroups
- listRuleGroups_nextMarker :: Lens' ListRuleGroups (Maybe Text)
- listRuleGroups_limit :: Lens' ListRuleGroups (Maybe Natural)
- data ListRuleGroupsResponse = ListRuleGroupsResponse' {
- ruleGroups :: Maybe [RuleGroupSummary]
- nextMarker :: Maybe Text
- httpStatus :: Int
- newListRuleGroupsResponse :: Int -> ListRuleGroupsResponse
- listRuleGroupsResponse_ruleGroups :: Lens' ListRuleGroupsResponse (Maybe [RuleGroupSummary])
- listRuleGroupsResponse_nextMarker :: Lens' ListRuleGroupsResponse (Maybe Text)
- listRuleGroupsResponse_httpStatus :: Lens' ListRuleGroupsResponse Int
Creating a Request
data ListRuleGroups Source #
See: newListRuleGroups
smart constructor.
ListRuleGroups' | |
|
Instances
newListRuleGroups :: ListRuleGroups Source #
Create a value of ListRuleGroups
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:ListRuleGroups'
, listRuleGroups_nextMarker
- If you specify a value for Limit
and you have more RuleGroups
than
the value of Limit
, AWS WAF returns a NextMarker
value in the
response that allows you to list another group of RuleGroups
. For the
second and subsequent ListRuleGroups
requests, specify the value of
NextMarker
from the previous response to get information about another
batch of RuleGroups
.
$sel:limit:ListRuleGroups'
, listRuleGroups_limit
- Specifies the number of RuleGroups
that you want AWS WAF to return for
this request. If you have more RuleGroups
than the number that you
specify for Limit
, the response includes a NextMarker
value that you
can use to get another batch of RuleGroups
.
Request Lenses
listRuleGroups_nextMarker :: Lens' ListRuleGroups (Maybe Text) Source #
If you specify a value for Limit
and you have more RuleGroups
than
the value of Limit
, AWS WAF returns a NextMarker
value in the
response that allows you to list another group of RuleGroups
. For the
second and subsequent ListRuleGroups
requests, specify the value of
NextMarker
from the previous response to get information about another
batch of RuleGroups
.
listRuleGroups_limit :: Lens' ListRuleGroups (Maybe Natural) Source #
Specifies the number of RuleGroups
that you want AWS WAF to return for
this request. If you have more RuleGroups
than the number that you
specify for Limit
, the response includes a NextMarker
value that you
can use to get another batch of RuleGroups
.
Destructuring the Response
data ListRuleGroupsResponse Source #
See: newListRuleGroupsResponse
smart constructor.
ListRuleGroupsResponse' | |
|
Instances
newListRuleGroupsResponse Source #
Create a value of ListRuleGroupsResponse
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:ruleGroups:ListRuleGroupsResponse'
, listRuleGroupsResponse_ruleGroups
- An array of RuleGroup objects.
$sel:nextMarker:ListRuleGroups'
, listRuleGroupsResponse_nextMarker
- If you have more RuleGroups
than the number that you specified for
Limit
in the request, the response includes a NextMarker
value. To
list more RuleGroups
, submit another ListRuleGroups
request, and
specify the NextMarker
value from the response in the NextMarker
value in the next request.
$sel:httpStatus:ListRuleGroupsResponse'
, listRuleGroupsResponse_httpStatus
- The response's http status code.
Response Lenses
listRuleGroupsResponse_ruleGroups :: Lens' ListRuleGroupsResponse (Maybe [RuleGroupSummary]) Source #
An array of RuleGroup objects.
listRuleGroupsResponse_nextMarker :: Lens' ListRuleGroupsResponse (Maybe Text) Source #
If you have more RuleGroups
than the number that you specified for
Limit
in the request, the response includes a NextMarker
value. To
list more RuleGroups
, submit another ListRuleGroups
request, and
specify the NextMarker
value from the response in the NextMarker
value in the next request.
listRuleGroupsResponse_httpStatus :: Lens' ListRuleGroupsResponse Int Source #
The response's http status code.