Table Of Contents

Feedback

User Guide

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

[ aws . waf ]

get-rule-group

Description

Returns the RuleGroup that is specified by the RuleGroupId that you included in the get-rule-group request.

To view the rules in a rule group, use list-activated-rules-in-rule-group .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-rule-group
--rule-group-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--rule-group-id (string)

The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by create-rule-group and by list-rule-groups .

--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

RuleGroup -> (structure)

Information about the RuleGroup that you specified in the get-rule-group request.

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 a 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)

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

MetricName -> (string)

A friendly name or description for the metrics for this RuleGroup . The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup .