listRuleGroups method

Future<ListRuleGroupsResponse> listRuleGroups({ required Scope scope, int? limit, String? nextMarker, })

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

May throw WAFInternalErrorException. May throw WAFInvalidParameterException. May throw WAFInvalidOperationException.

Parameter scope : Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

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.

Parameter limit : The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

Parameter 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, AWS 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.

Implementation

Future<ListRuleGroupsResponse> listRuleGroups({
  required Scope scope,
  int? limit,
  String? nextMarker,
}) async {
  ArgumentError.checkNotNull(scope, 'scope');
  _s.validateNumRange(
    'limit',
    limit,
    1,
    100,
  );
  _s.validateStringLength(
    'nextMarker',
    nextMarker,
    1,
    256,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSWAF_20190729.ListRuleGroups'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Scope': scope.toValue(),
      if (limit != null) 'Limit': limit,
      if (nextMarker != null) 'NextMarker': nextMarker,
    },
  );

  return ListRuleGroupsResponse.fromJson(jsonResponse.body);
}