AWS WAF Regional

{'WebACL': {'Rules': {'ExcludedRules': [{'RuleId': 'string'}]}}}

Creates a WebACL , which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule .

You also specify a default action, either ALLOW or BLOCK . If a web request doesn't match any of the Rules in a WebACL , AWS WAF responds to the request with the default action.

To create and configure a WebACL , perform the following steps:

• Create and update the ByteMatchSet objects and other predicates that you want to include in Rules . For more information, see CreateByteMatchSet , UpdateByteMatchSet , CreateIPSet , UpdateIPSet , CreateSqlInjectionMatchSet , and UpdateSqlInjectionMatchSet .

• Create and update the Rules that you want to include in the WebACL . For more information, see CreateRule and UpdateRule .

• Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request.

• Submit a CreateWebACL request.

• Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

• Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL , to specify the default action, and to associate the WebACL with a CloudFront distribution.

For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide .

See also: AWS API Documentation

Request Syntax

client.create_web_acl(
    Name='string',
    MetricName='string',
    DefaultAction={
        'Type': 'BLOCK'|'ALLOW'|'COUNT'
    },
    ChangeToken='string'
)

type Name

string

param Name

[REQUIRED]

A friendly name or description of the WebACL . You can't change Name after you create the WebACL .

type MetricName

string

param MetricName

[REQUIRED]

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

type DefaultAction

dict

param DefaultAction

[REQUIRED]

The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL .

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

type ChangeToken

string

param ChangeToken

[REQUIRED]

The value returned by the most recent call to GetChangeToken .

rtype

dict

returns

Response Syntax

{
    'WebACL': {
        'WebACLId': 'string',
        'Name': 'string',
        'MetricName': 'string',
        'DefaultAction': {
            'Type': 'BLOCK'|'ALLOW'|'COUNT'
        },
        'Rules': [
            {
                'Priority': 123,
                'RuleId': 'string',
                'Action': {
                    'Type': 'BLOCK'|'ALLOW'|'COUNT'
                },
                'OverrideAction': {
                    'Type': 'NONE'|'COUNT'
                },
                'Type': 'REGULAR'|'RATE_BASED'|'GROUP',
                'ExcludedRules': [
                    {
                        'RuleId': 'string'
                    },
                ]
            },
        ],
        'WebACLArn': 'string'
    },
    'ChangeToken': 'string'
}

Response Structure

• (dict) --

  • WebACL (dict) --

    The WebACL returned in the CreateWebACL response.

    • WebACLId (string) --

      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 .

    • Name (string) --

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

    • 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); the name can't contain whitespace. You can't change MetricName after you create the WebACL .

    • DefaultAction (dict) --

      The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

      • Type (string) --

        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 .

    • Rules (list) --

      An array that contains the action for each Rule in a WebACL , the priority of the Rule , and the ID of the Rule .

      • (dict) --

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

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

          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 .

        • Action (dict) --

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

            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 .

        • OverrideAction (dict) --

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

            COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE , the rule's action will take place.

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

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

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

          • (dict) --

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

              The unique identifier for the rule to exclude from the rule group.

    • WebACLArn (string) --

      Tha Amazon Resource Name (ARN) of the web ACL.

  • ChangeToken (string) --

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

{'WebACL': {'Rules': {'ExcludedRules': [{'RuleId': 'string'}]}}}

Returns the WebACL that is specified by WebACLId .

See also: AWS API Documentation

Request Syntax

client.get_web_acl(
    WebACLId='string'
)

type WebACLId

string

param WebACLId

[REQUIRED]

The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs .

rtype

dict

returns

Response Syntax

{
    'WebACL': {
        'WebACLId': 'string',
        'Name': 'string',
        'MetricName': 'string',
        'DefaultAction': {
            'Type': 'BLOCK'|'ALLOW'|'COUNT'
        },
        'Rules': [
            {
                'Priority': 123,
                'RuleId': 'string',
                'Action': {
                    'Type': 'BLOCK'|'ALLOW'|'COUNT'
                },
                'OverrideAction': {
                    'Type': 'NONE'|'COUNT'
                },
                'Type': 'REGULAR'|'RATE_BASED'|'GROUP',
                'ExcludedRules': [
                    {
                        'RuleId': 'string'
                    },
                ]
            },
        ],
        'WebACLArn': 'string'
    }
}

Response Structure

• (dict) --

  • WebACL (dict) --

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

      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 .

    • Name (string) --

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

    • 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); the name can't contain whitespace. You can't change MetricName after you create the WebACL .

    • DefaultAction (dict) --

      The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

      • Type (string) --

        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 .

    • Rules (list) --

      An array that contains the action for each Rule in a WebACL , the priority of the Rule , and the ID of the Rule .

      • (dict) --

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

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

          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 .

        • Action (dict) --

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

            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 .

        • OverrideAction (dict) --

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

            COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE , the rule's action will take place.

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

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

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

          • (dict) --

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

              The unique identifier for the rule to exclude from the rule group.

    • WebACLArn (string) --

      Tha Amazon Resource Name (ARN) of the web ACL.

{'ActivatedRules': {'ExcludedRules': [{'RuleId': 'string'}]}}

Returns an array of ActivatedRule objects.

See also: AWS API Documentation

Request Syntax

client.list_activated_rules_in_rule_group(
    RuleGroupId='string',
    NextMarker='string',
    Limit=123
)

type RuleGroupId

string

param RuleGroupId

The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.

type NextMarker

string

param NextMarker

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

type Limit

integer

param Limit

Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit , the response includes a NextMarker value that you can use to get another batch of ActivatedRules .

rtype

dict

returns

Response Syntax

{
    'NextMarker': 'string',
    'ActivatedRules': [
        {
            'Priority': 123,
            'RuleId': 'string',
            'Action': {
                'Type': 'BLOCK'|'ALLOW'|'COUNT'
            },
            'OverrideAction': {
                'Type': 'NONE'|'COUNT'
            },
            'Type': 'REGULAR'|'RATE_BASED'|'GROUP',
            'ExcludedRules': [
                {
                    'RuleId': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) --

  • NextMarker (string) --

    If you have more ActivatedRules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ActivatedRules , submit another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from the response in the NextMarker value in the next request.

  • ActivatedRules (list) --

    An array of ActivatedRules objects.

    • (dict) --

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

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

        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 .

      • Action (dict) --

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

          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 .

      • OverrideAction (dict) --

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

          COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE , the rule's action will take place.

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

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

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

        • (dict) --

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

            The unique identifier for the rule to exclude from the rule group.

{'Updates': {'ActivatedRule': {'ExcludedRules': [{'RuleId': 'string'}]}}}

Inserts or deletes ActivatedRule objects in a RuleGroup .

You can only insert REGULAR rules into a rule group.

You can have a maximum of ten rules per rule group.

To create and configure a RuleGroup , perform the following steps:

• Create and update the Rules that you want to include in the RuleGroup . See CreateRule .

• Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request.

• Submit an UpdateRuleGroup request to add Rules to the RuleGroup .

• Create and update a WebACL that contains the RuleGroup . See CreateWebACL .

If you want to replace one Rule with another, you delete the existing one and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide .

See also: AWS API Documentation

Request Syntax

client.update_rule_group(
    RuleGroupId='string',
    Updates=[
        {
            'Action': 'INSERT'|'DELETE',
            'ActivatedRule': {
                'Priority': 123,
                'RuleId': 'string',
                'Action': {
                    'Type': 'BLOCK'|'ALLOW'|'COUNT'
                },
                'OverrideAction': {
                    'Type': 'NONE'|'COUNT'
                },
                'Type': 'REGULAR'|'RATE_BASED'|'GROUP',
                'ExcludedRules': [
                    {
                        'RuleId': 'string'
                    },
                ]
            }
        },
    ],
    ChangeToken='string'
)

type RuleGroupId

string

param RuleGroupId

[REQUIRED]

The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups .

type Updates

list

param Updates

[REQUIRED]

An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup .

You can only insert REGULAR rules into a rule group.

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 .

• (dict) --

  Specifies an ActivatedRule and indicates whether you want to add it to a RuleGroup or delete it from a RuleGroup .

  • Action (string) -- [REQUIRED]

    Specify INSERT to add an ActivatedRule to a RuleGroup . Use DELETE to remove an ActivatedRule from a RuleGroup .

  • ActivatedRule (dict) -- [REQUIRED]

    The ActivatedRule object 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 ).

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

    • Action (dict) --

      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 .

    • OverrideAction (dict) --

      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.

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

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

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

      • (dict) --

        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.

type ChangeToken

string

param ChangeToken

[REQUIRED]

The value returned by the most recent call to GetChangeToken .

rtype

dict

returns

Response Syntax

{
    'ChangeToken': 'string'
}

Response Structure

• (dict) --

  • ChangeToken (string) --

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

{'Updates': {'ActivatedRule': {'ExcludedRules': [{'RuleId': 'string'}]}}}

Inserts or deletes ActivatedRule objects in a WebACL . Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL , you specify the following values:

• A default action for the WebACL , either ALLOW or BLOCK . AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL .

• The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.

• For each Rule , whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule .

• The order in which you want AWS WAF to evaluate the Rules in a WebACL . If you add more than one Rule to a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority . (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets ) in a Rule , AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL , if any.

To create and configure a WebACL , perform the following steps:

• Create and update the predicates that you want to include in Rules . For more information, see CreateByteMatchSet , UpdateByteMatchSet , CreateIPSet , UpdateIPSet , CreateSqlInjectionMatchSet , and UpdateSqlInjectionMatchSet .

• Create and update the Rules that you want to include in the WebACL . For more information, see CreateRule and UpdateRule .

• Create a WebACL . See CreateWebACL .

• Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

• Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL , to specify the default action, and to associate the WebACL with a CloudFront distribution. The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule , you can exclude specific rules from that rule group. If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules .

Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide .

See also: AWS API Documentation

Request Syntax

client.update_web_acl(
    WebACLId='string',
    ChangeToken='string',
    Updates=[
        {
            'Action': 'INSERT'|'DELETE',
            'ActivatedRule': {
                'Priority': 123,
                'RuleId': 'string',
                'Action': {
                    'Type': 'BLOCK'|'ALLOW'|'COUNT'
                },
                'OverrideAction': {
                    'Type': 'NONE'|'COUNT'
                },
                'Type': 'REGULAR'|'RATE_BASED'|'GROUP',
                'ExcludedRules': [
                    {
                        'RuleId': 'string'
                    },
                ]
            }
        },
    ],
    DefaultAction={
        'Type': 'BLOCK'|'ALLOW'|'COUNT'
    }
)

type WebACLId

string

param WebACLId

[REQUIRED]

The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs .

type ChangeToken

string

param ChangeToken

[REQUIRED]

The value returned by the most recent call to GetChangeToken .

type Updates

list

param Updates

An array of updates to make to the WebACL .

An array of WebACLUpdate objects that you want to insert into or delete from a WebACL . For more information, see the applicable data types:

• WebACLUpdate : Contains Action and ActivatedRule

• ActivatedRule : Contains Action , OverrideAction , Priority , RuleId , and Type . 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 .

• WafAction : Contains Type

• (dict) --

  Specifies whether to insert a Rule into or delete a Rule from a WebACL .

  • Action (string) -- [REQUIRED]

    Specifies whether to insert a Rule into or delete a Rule from a WebACL .

  • ActivatedRule (dict) -- [REQUIRED]

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

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

    • Action (dict) --

      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 .

    • OverrideAction (dict) --

      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.

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

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

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

      • (dict) --

        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.

type DefaultAction

dict

param DefaultAction

A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.

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

rtype

dict

returns

Response Syntax

{
    'ChangeToken': 'string'
}

Response Structure

• (dict) --

  • ChangeToken (string) --

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