# get-web-acl ## Description #### NOTE This is **AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide. > **For the latest version of AWS WAF** , use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) . With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the WebACL that is specified by `WebACLId` . See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/waf-2015-08-24/GetWebACL) ## Synopsis ``` get-web-acl --web-acl-id [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] ``` ## Options `--web-acl-id` (string) [required] > The `WebACLId` of the WebACL that you want to get. `WebACLId` is returned by CreateWebACL and by ListWebACLs . > Constraints: > * min: `1` > * max: `128` > * pattern: `.*\S.*` `--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those 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. This may not be specified along with `--cli-input-yaml`. `--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`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated. ## Global Options `--debug` (boolean) Turn on debug logging. `--endpoint-url` (string) Override command’s default URL with the given URL. `--no-verify-ssl` (boolean) By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates. `--no-paginate` (boolean) Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results. `--output` (string) The formatting style for command output. * json * text * table * yaml * yaml-stream * off `--query` (string) A JMESPath query to use in filtering the response data. `--profile` (string) Use a specific profile from your credential file. `--region` (string) The region to use. Overrides config/env settings. `--version` (string) Display the version of this tool. `--color` (string) Turn on/off color output. * on * off * auto `--no-sign-request` (boolean) Do not sign requests. Credentials will not be loaded if this argument is provided. `--ca-bundle` (string) The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings. `--cli-read-timeout` (int) The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds. `--cli-connect-timeout` (int) The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds. `--cli-binary-format` (string) The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`. * base64 * raw-in-base64-out `--no-cli-pager` (boolean) Disable cli pager for output. `--cli-auto-prompt` (boolean) Automatically prompt for CLI input parameters. `--no-cli-auto-prompt` (boolean) Disable automatically prompt for CLI input parameters. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced ## Output WebACL -> (structure) > Information about the WebACL that you specified in the `GetWebACL` request. For more information, see the following topics: > * WebACL : Contains `DefaultAction` , `MetricName` , `Name` , an array of `Rule` objects, and `WebACLId` > * `DefaultAction` (Data type is WafAction ): Contains `Type` > * `Rules` : Contains an array of `ActivatedRule` objects, which contain `Action` , `Priority` , and `RuleId` > * `Action` : Contains `Type` > WebACLId -> (string) [required] > > A unique identifier for a `WebACL` . You use `WebACLId` to get information about a `WebACL` (see GetWebACL ), update a `WebACL` (see UpdateWebACL ), and delete a `WebACL` from AWS WAF (see DeleteWebACL ). > > > `WebACLId` is returned by CreateWebACL and by ListWebACLs . > > Constraints: > > * min: `1` > > * max: `128` > > * pattern: `.*\S.*` > Name -> (string) > > A friendly name or description of the `WebACL` . You can’t change the name of a `WebACL` after you create it. > > Constraints: > > * min: `1` > > * max: `128` > > * pattern: `.*\S.*` > MetricName -> (string) > > A friendly name or description for the metrics for this `WebACL` . The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can’t contain whitespace or metric names reserved for AWS WAF, including “All” and “Default_Action.” You can’t change `MetricName` after you create the `WebACL` . > > Constraints: > > * min: `1` > > * max: `128` > > * pattern: `.*\S.*` > DefaultAction -> (structure) [required] > > The action to perform if none of the `Rules` contained in the `WebACL` match. The action is specified by the WafAction object. > > Type -> (string) [required] > > > Specifies how you want AWS WAF to respond to requests that match the settings in a `Rule` . Valid settings include the following: > > > * `ALLOW` : AWS WAF allows requests > > > * `BLOCK` : AWS WAF blocks requests > > > * `COUNT` : AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can’t specify `COUNT` for the default action for a `WebACL` . > > > Possible values: > > > * `BLOCK` > > > * `ALLOW` > > > * `COUNT` > Rules -> (list) [required] > > An array that contains the action for each `Rule` in a `WebACL` , the priority of the `Rule` , and the ID of the `Rule` . > > (structure) > > > #### NOTE > > > This is **AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide. > > > > **For the latest version of AWS WAF** , use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) . With the latest version, AWS WAF has a single set of endpoints for regional and global use. > > > The `ActivatedRule` object in an UpdateWebACL request specifies a `Rule` that you want to insert or delete, the priority of the `Rule` in the `WebACL` , and the action that you want AWS WAF to take when a web request matches the `Rule` (`ALLOW` , `BLOCK` , or `COUNT` ). > > > To specify whether to insert or delete a `Rule` , use the `Action` parameter in the WebACLUpdate data type. > > > Priority -> (integer) [required] > > > > Specifies the order in which the `Rules` in a `WebACL` are evaluated. Rules with a lower value for `Priority` are evaluated before `Rules` with a higher value. The value must be a unique integer. If you add multiple `Rules` to a `WebACL` , the values don’t need to be consecutive. > > > RuleId -> (string) [required] > > > > The `RuleId` for a `Rule` . You use `RuleId` to get more information about a `Rule` (see GetRule ), update a `Rule` (see UpdateRule ), insert a `Rule` into a `WebACL` or delete a one from a `WebACL` (see UpdateWebACL ), or delete a `Rule` from AWS WAF (see DeleteRule ). > > > > > `RuleId` is returned by CreateRule and by ListRules . > > > > Constraints: > > > > * min: `1` > > > > * max: `128` > > > > * pattern: `.*\S.*` > > > Action -> (structure) > > > > Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the `Rule` . Valid values for `Action` include the following: > > > > * `ALLOW` : CloudFront responds with the requested object. > > > > * `BLOCK` : CloudFront responds with an HTTP 403 (Forbidden) status code. > > > > * `COUNT` : AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL. > > > > > `ActivatedRule|OverrideAction` applies only when updating or adding a `RuleGroup` to a `WebACL` . In this case, you do not use `ActivatedRule|Action` . For all other update requests, `ActivatedRule|Action` is used instead of `ActivatedRule|OverrideAction` . > > > > Type -> (string) [required] > > > > > Specifies how you want AWS WAF to respond to requests that match the settings in a `Rule` . Valid settings include the following: > > > > > * `ALLOW` : AWS WAF allows requests > > > > > * `BLOCK` : AWS WAF blocks requests > > > > > * `COUNT` : AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can’t specify `COUNT` for the default action for a `WebACL` . > > > > > Possible values: > > > > > * `BLOCK` > > > > > * `ALLOW` > > > > > * `COUNT` > > > OverrideAction -> (structure) > > > > Use the `OverrideAction` to test your `RuleGroup` . > > > > Any rule in a `RuleGroup` can potentially block a request. If you set the `OverrideAction` to `None` , the `RuleGroup` will block a request if any individual rule in the `RuleGroup` matches the request and is configured to block that request. However if you first want to test the `RuleGroup` , set the `OverrideAction` to `Count` . The `RuleGroup` will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests . > > > > > `ActivatedRule|OverrideAction` applies only when updating or adding a `RuleGroup` to a `WebACL` . In this case you do not use `ActivatedRule|Action` . For all other update requests, `ActivatedRule|Action` is used instead of `ActivatedRule|OverrideAction` . > > > > Type -> (string) [required] > > > > > > `COUNT` overrides the action specified by the individual rule within a `RuleGroup` . If set to `NONE` , the rule’s action will take place. > > > > > Possible values: > > > > > * `NONE` > > > > > * `COUNT` > > > Type -> (string) > > > > The rule type, either `REGULAR` , as defined by Rule , `RATE_BASED` , as defined by RateBasedRule , or `GROUP` , as defined by RuleGroup . The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist. > > > > Possible values: > > > > * `REGULAR` > > > > * `RATE_BASED` > > > > * `GROUP` > > > ExcludedRules -> (list) > > > > An array of rules to exclude from a rule group. This is applicable only when the `ActivatedRule` refers to a `RuleGroup` . > > > > Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL. > > > > Specifying `ExcludedRules` does not remove those rules from the rule group. Rather, it changes the action for the rules to `COUNT` . Therefore, requests that match an `ExcludedRule` are counted but not blocked. The `RuleGroup` owner will receive COUNT metrics for each `ExcludedRule` . > > > > If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps: > > > > * Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see [Logging Web ACL Traffic Information](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) . > > > > * Submit an UpdateWebACL request that has two actions: > > > > * The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first `Updates:Action` should be `DELETE` and `Updates:ActivatedRule:RuleId` should be the rule group that contains the rules that you want to exclude. > > > > * The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second `Updates:Action` should be `INSERT` , `Updates:ActivatedRule:RuleId` should be the rule group that you just removed, and `ExcludedRules` should contain the rules that you want to exclude. > > > > (structure) > > > > > #### NOTE > > > > > This is **AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide. > > > > > > **For the latest version of AWS WAF** , use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) . With the latest version, AWS WAF has a single set of endpoints for regional and global use. > > > > > The rule to exclude from a rule group. This is applicable only when the `ActivatedRule` refers to a `RuleGroup` . The rule must belong to the `RuleGroup` that is specified by the `ActivatedRule` . > > > > > RuleId -> (string) [required] > > > > > > The unique identifier for the rule to exclude from the rule group. > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `128` > > > > > > * pattern: `.*\S.*` > WebACLArn -> (string) > > Tha Amazon Resource Name (ARN) of the web ACL. > > Constraints: > > * min: `1` > > * max: `1224` > > * pattern: `.*\S.*`