Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . waf ]

list-rule-groups

Description

Returns an array of RuleGroup objects.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-rule-groups
[--next-marker <value>]
[--limit <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--next-marker (string)

If you specify a value for Limit and you have more RuleGroups than the value of Limit , AWS WAF returns a next-marker value in the response that allows you to list another group of RuleGroups . For the second and subsequent list-rule-groups requests, specify the value of next-marker from the previous response to get information about another batch of RuleGroups .

--limit (integer)

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 next-marker value that you can use to get another batch of RuleGroups .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

NextMarker -> (string)

If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a next-marker value. To list more RuleGroups , submit another list-rule-groups request, and specify the next-marker value from the response in the next-marker value in the next request.

RuleGroups -> (list)

An array of RuleGroup objects.

(structure)

Contains the identifier and the friendly name or description of the RuleGroup .

RuleGroupId -> (string)

A unique identifier for a RuleGroup . You use RuleGroupId to get more information about a RuleGroup (see get-rule-group ), update a RuleGroup (see update-rule-group ), insert a RuleGroup into a WebACL or delete one from a WebACL (see update-web-acl ), or delete a RuleGroup from AWS WAF (see delete-rule-group ).

RuleGroupId is returned by create-rule-group and by list-rule-groups .

Name -> (string)

A friendly name or description of the RuleGroup . You can't change the name of a RuleGroup after you create it.