| 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.WAFV2.ListRuleGroups
Description
Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
Synopsis
- data ListRuleGroups = ListRuleGroups' {}
- newListRuleGroups :: Scope -> ListRuleGroups
- listRuleGroups_limit :: Lens' ListRuleGroups (Maybe Natural)
- listRuleGroups_nextMarker :: Lens' ListRuleGroups (Maybe Text)
- listRuleGroups_scope :: Lens' ListRuleGroups Scope
- data ListRuleGroupsResponse = ListRuleGroupsResponse' {
- nextMarker :: Maybe Text
- ruleGroups :: Maybe [RuleGroupSummary]
- httpStatus :: Int
- newListRuleGroupsResponse :: Int -> ListRuleGroupsResponse
- listRuleGroupsResponse_nextMarker :: Lens' ListRuleGroupsResponse (Maybe Text)
- listRuleGroupsResponse_ruleGroups :: Lens' ListRuleGroupsResponse (Maybe [RuleGroupSummary])
- listRuleGroupsResponse_httpStatus :: Lens' ListRuleGroupsResponse Int
Creating a Request
data ListRuleGroups Source #
See: newListRuleGroups smart constructor.
Constructors
| ListRuleGroups' | |
Fields
| |
Instances
Arguments
| :: Scope | |
| -> ListRuleGroups |
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:
ListRuleGroups, listRuleGroups_limit - The maximum number of objects that you want WAF to return for this
request. If more objects are available, in the response, WAF provides a
NextMarker value that you can use in a subsequent call to get the next
batch of objects.
ListRuleGroups, listRuleGroups_nextMarker - When you request a list of objects with a Limit setting, if the number
of objects that are still available for retrieval exceeds the limit, WAF
returns a NextMarker value in the response. To retrieve the next batch
of objects, provide the marker from the prior call in your next request.
ListRuleGroups, listRuleGroups_scope - Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load
Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API,
or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
- CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1. - API and SDKs - For all calls, use the Region endpoint us-east-1.
Request Lenses
listRuleGroups_limit :: Lens' ListRuleGroups (Maybe Natural) Source #
The maximum number of objects that you want WAF to return for this
request. If more objects are available, in the response, WAF provides a
NextMarker value that you can use in a subsequent call to get the next
batch of objects.
listRuleGroups_nextMarker :: Lens' ListRuleGroups (Maybe Text) Source #
When you request a list of objects with a Limit setting, if the number
of objects that are still available for retrieval exceeds the limit, WAF
returns a NextMarker value in the response. To retrieve the next batch
of objects, provide the marker from the prior call in your next request.
listRuleGroups_scope :: Lens' ListRuleGroups Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
- CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1. - API and SDKs - For all calls, use the Region endpoint us-east-1.
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_nextMarker - When you request a list of objects with a Limit setting, if the number
of objects that are still available for retrieval exceeds the limit, WAF
returns a NextMarker value in the response. To retrieve the next batch
of objects, provide the marker from the prior call in your next request.
$sel:ruleGroups:ListRuleGroupsResponse', listRuleGroupsResponse_ruleGroups -
$sel:httpStatus:ListRuleGroupsResponse', listRuleGroupsResponse_httpStatus - The response's http status code.
Response Lenses
listRuleGroupsResponse_nextMarker :: Lens' ListRuleGroupsResponse (Maybe Text) Source #
When you request a list of objects with a Limit setting, if the number
of objects that are still available for retrieval exceeds the limit, WAF
returns a NextMarker value in the response. To retrieve the next batch
of objects, provide the marker from the prior call in your next request.
listRuleGroupsResponse_ruleGroups :: Lens' ListRuleGroupsResponse (Maybe [RuleGroupSummary]) Source #
listRuleGroupsResponse_httpStatus :: Lens' ListRuleGroupsResponse Int Source #
The response's http status code.