Skip to content

List Rule Groups

wafv2_list_rule_groups R Documentation

Retrieves an array of RuleGroupSummary objects for the rule groups that you manage

Description

Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.

Usage

wafv2_list_rule_groups(Scope, NextMarker, Limit)

Arguments

Scope

[required] 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, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

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.

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.

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.

Value

A list with the following syntax: 

list(
  NextMarker = "string",
  RuleGroups = list(
    list(
      Name = "string",
      Id = "string",
      Description = "string",
      LockToken = "string",
      ARN = "string"
    )
  )
)

Request syntax

svc$list_rule_groups(
  Scope = "CLOUDFRONT"|"REGIONAL",
  NextMarker = "string",
  Limit = 123
)