Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . waf ]

delete-rule

Description

Note

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a Rule . You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

If you just want to remove a Rule from a WebACL , use UpdateWebACL .

To permanently delete a Rule from AWS WAF, perform the following steps:

  • Update the Rule to remove predicates, if any. For more information, see UpdateRule .
  • Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request.
  • Submit a DeleteRule request.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-rule
--rule-id <value>
--change-token <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--rule-id (string)

The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules .

--change-token (string)

The value returned by the most recent call to GetChangeToken .

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

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

ChangeToken -> (string)

The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus .