| 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.NetworkFirewall.ListRuleGroups
Description
Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list.
This operation returns paginated results.
Synopsis
- data ListRuleGroups = ListRuleGroups' {}
- newListRuleGroups :: ListRuleGroups
- listRuleGroups_managedType :: Lens' ListRuleGroups (Maybe ResourceManagedType)
- listRuleGroups_maxResults :: Lens' ListRuleGroups (Maybe Natural)
- listRuleGroups_nextToken :: Lens' ListRuleGroups (Maybe Text)
- listRuleGroups_scope :: Lens' ListRuleGroups (Maybe ResourceManagedStatus)
- listRuleGroups_type :: Lens' ListRuleGroups (Maybe RuleGroupType)
- data ListRuleGroupsResponse = ListRuleGroupsResponse' {
- nextToken :: Maybe Text
- ruleGroups :: Maybe [RuleGroupMetadata]
- httpStatus :: Int
- newListRuleGroupsResponse :: Int -> ListRuleGroupsResponse
- listRuleGroupsResponse_nextToken :: Lens' ListRuleGroupsResponse (Maybe Text)
- listRuleGroupsResponse_ruleGroups :: Lens' ListRuleGroupsResponse (Maybe [RuleGroupMetadata])
- listRuleGroupsResponse_httpStatus :: Lens' ListRuleGroupsResponse Int
Creating a Request
data ListRuleGroups Source #
See: newListRuleGroups smart constructor.
Constructors
| ListRuleGroups' | |
Fields
| |
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:managedType:ListRuleGroups', listRuleGroups_managedType - Indicates the general category of the Amazon Web Services managed rule
group.
$sel:maxResults:ListRuleGroups', listRuleGroups_maxResults - The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response,
Network Firewall provides a NextToken value that you can use in a
subsequent call to get the next batch of objects.
ListRuleGroups, listRuleGroups_nextToken - When you request a list of objects with a MaxResults setting, if the
number of objects that are still available for retrieval exceeds the
maximum you requested, Network Firewall returns a NextToken value in
the response. To retrieve the next batch of objects, use the token
returned from the prior request in your next request.
$sel:scope:ListRuleGroups', listRuleGroups_scope - The scope of the request. The default setting of ACCOUNT or a setting
of NULL returns all of the rule groups in your account. A setting of
MANAGED returns all available managed rule groups.
ListRuleGroups, listRuleGroups_type - Indicates whether the rule group is stateless or stateful. If the rule
group is stateless, it contains stateless rules. If it is stateful, it
contains stateful rules.
Request Lenses
listRuleGroups_managedType :: Lens' ListRuleGroups (Maybe ResourceManagedType) Source #
Indicates the general category of the Amazon Web Services managed rule group.
listRuleGroups_maxResults :: Lens' ListRuleGroups (Maybe Natural) Source #
The maximum number of objects that you want Network Firewall to return
for this request. If more objects are available, in the response,
Network Firewall provides a NextToken value that you can use in a
subsequent call to get the next batch of objects.
listRuleGroups_nextToken :: Lens' ListRuleGroups (Maybe Text) Source #
When you request a list of objects with a MaxResults setting, if the
number of objects that are still available for retrieval exceeds the
maximum you requested, Network Firewall returns a NextToken value in
the response. To retrieve the next batch of objects, use the token
returned from the prior request in your next request.
listRuleGroups_scope :: Lens' ListRuleGroups (Maybe ResourceManagedStatus) Source #
The scope of the request. The default setting of ACCOUNT or a setting
of NULL returns all of the rule groups in your account. A setting of
MANAGED returns all available managed rule groups.
listRuleGroups_type :: Lens' ListRuleGroups (Maybe RuleGroupType) Source #
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
Destructuring the Response
data ListRuleGroupsResponse Source #
See: newListRuleGroupsResponse smart constructor.
Constructors
| ListRuleGroupsResponse' | |
Fields
| |
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:
ListRuleGroups, listRuleGroupsResponse_nextToken - When you request a list of objects with a MaxResults setting, if the
number of objects that are still available for retrieval exceeds the
maximum you requested, Network Firewall returns a NextToken value in
the response. To retrieve the next batch of objects, use the token
returned from the prior request in your next request.
$sel:ruleGroups:ListRuleGroupsResponse', listRuleGroupsResponse_ruleGroups - The rule group metadata objects that you've defined. Depending on your
setting for max results and the number of rule groups, this might not be
the full list.
$sel:httpStatus:ListRuleGroupsResponse', listRuleGroupsResponse_httpStatus - The response's http status code.
Response Lenses
listRuleGroupsResponse_nextToken :: Lens' ListRuleGroupsResponse (Maybe Text) Source #
When you request a list of objects with a MaxResults setting, if the
number of objects that are still available for retrieval exceeds the
maximum you requested, Network Firewall returns a NextToken value in
the response. To retrieve the next batch of objects, use the token
returned from the prior request in your next request.
listRuleGroupsResponse_ruleGroups :: Lens' ListRuleGroupsResponse (Maybe [RuleGroupMetadata]) Source #
The rule group metadata objects that you've defined. Depending on your setting for max results and the number of rule groups, this might not be the full list.
listRuleGroupsResponse_httpStatus :: Lens' ListRuleGroupsResponse Int Source #
The response's http status code.