Interface WafClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

    @Generated("software.amazon.awssdk:codegen")
    @ThreadSafe
    public interface WafClient
    extends AwsClient
    Service client for accessing WAF. This can be created using the static builder() method.

    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.

    This is the AWS WAF Classic API Reference for using AWS WAF Classic with Amazon CloudFront. The AWS WAF Classic actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the AWS WAF Classic in the developer guide.

    • Method Detail

      • createByteMatchSet

        default CreateByteMatchSetResponse createByteMatchSet​(CreateByteMatchSetRequest createByteMatchSetRequest)
                                                       throws WafDisallowedNameException,
                                                              WafInternalErrorException,
                                                              WafInvalidAccountException,
                                                              WafInvalidParameterException,
                                                              WafStaleDataException,
                                                              WafLimitsExceededException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              WafException

        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.

        Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.

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

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

        2. Submit a CreateByteMatchSet request.

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

        4. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

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

        Parameters:
        createByteMatchSetRequest -
        Returns:
        Result of the CreateByteMatchSet operation returned by the service.
        Throws:
        WafDisallowedNameException - The name specified is invalid.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createByteMatchSet

        default CreateByteMatchSetResponse createByteMatchSet​(Consumer<CreateByteMatchSetRequest.Builder> createByteMatchSetRequest)
                                                       throws WafDisallowedNameException,
                                                              WafInternalErrorException,
                                                              WafInvalidAccountException,
                                                              WafInvalidParameterException,
                                                              WafStaleDataException,
                                                              WafLimitsExceededException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              WafException

        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.

        Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.

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

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

        2. Submit a CreateByteMatchSet request.

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

        4. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

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


        This is a convenience which creates an instance of the CreateByteMatchSetRequest.Builder avoiding the need to create one manually via CreateByteMatchSetRequest.builder()

        Parameters:
        createByteMatchSetRequest - A Consumer that will call methods on CreateByteMatchSetRequest.Builder to create a request.
        Returns:
        Result of the CreateByteMatchSet operation returned by the service.
        Throws:
        WafDisallowedNameException - The name specified is invalid.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createGeoMatchSet

        default CreateGeoMatchSetResponse createGeoMatchSet​(CreateGeoMatchSetRequest createGeoMatchSetRequest)
                                                     throws WafStaleDataException,
                                                            WafInternalErrorException,
                                                            WafInvalidAccountException,
                                                            WafDisallowedNameException,
                                                            WafInvalidParameterException,
                                                            WafLimitsExceededException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            WafException

        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.

        Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests.

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

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

        2. Submit a CreateGeoMatchSet request.

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

        4. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for.

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

        Parameters:
        createGeoMatchSetRequest -
        Returns:
        Result of the CreateGeoMatchSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafDisallowedNameException - The name specified is invalid.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createGeoMatchSet

        default CreateGeoMatchSetResponse createGeoMatchSet​(Consumer<CreateGeoMatchSetRequest.Builder> createGeoMatchSetRequest)
                                                     throws WafStaleDataException,
                                                            WafInternalErrorException,
                                                            WafInvalidAccountException,
                                                            WafDisallowedNameException,
                                                            WafInvalidParameterException,
                                                            WafLimitsExceededException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            WafException

        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.

        Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests.

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

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

        2. Submit a CreateGeoMatchSet request.

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

        4. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for.

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


        This is a convenience which creates an instance of the CreateGeoMatchSetRequest.Builder avoiding the need to create one manually via CreateGeoMatchSetRequest.builder()

        Parameters:
        createGeoMatchSetRequest - A Consumer that will call methods on CreateGeoMatchSetRequest.Builder to create a request.
        Returns:
        Result of the CreateGeoMatchSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafDisallowedNameException - The name specified is invalid.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createIPSet

        default CreateIpSetResponse createIPSet​(CreateIpSetRequest createIpSetRequest)
                                         throws WafStaleDataException,
                                                WafInternalErrorException,
                                                WafInvalidAccountException,
                                                WafDisallowedNameException,
                                                WafInvalidParameterException,
                                                WafLimitsExceededException,
                                                AwsServiceException,
                                                SdkClientException,
                                                WafException

        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.

        Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.

        To create and configure an IPSet, perform the following steps:

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

        2. Submit a CreateIPSet request.

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

        4. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

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

        Parameters:
        createIpSetRequest -
        Returns:
        Result of the CreateIPSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafDisallowedNameException - The name specified is invalid.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createIPSet

        default CreateIpSetResponse createIPSet​(Consumer<CreateIpSetRequest.Builder> createIpSetRequest)
                                         throws WafStaleDataException,
                                                WafInternalErrorException,
                                                WafInvalidAccountException,
                                                WafDisallowedNameException,
                                                WafInvalidParameterException,
                                                WafLimitsExceededException,
                                                AwsServiceException,
                                                SdkClientException,
                                                WafException

        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.

        Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.

        To create and configure an IPSet, perform the following steps:

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

        2. Submit a CreateIPSet request.

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

        4. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

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


        This is a convenience which creates an instance of the CreateIpSetRequest.Builder avoiding the need to create one manually via CreateIpSetRequest.builder()

        Parameters:
        createIpSetRequest - A Consumer that will call methods on CreateIpSetRequest.Builder to create a request.
        Returns:
        Result of the CreateIPSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafDisallowedNameException - The name specified is invalid.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createRateBasedRule

        default CreateRateBasedRuleResponse createRateBasedRule​(CreateRateBasedRuleRequest createRateBasedRuleRequest)
                                                         throws WafStaleDataException,
                                                                WafInternalErrorException,
                                                                WafDisallowedNameException,
                                                                WafInvalidParameterException,
                                                                WafLimitsExceededException,
                                                                WafTagOperationException,
                                                                WafTagOperationInternalErrorException,
                                                                WafBadRequestException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                WafException

        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.

        Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit.

        If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the conditions to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

        • An IPSet that matches the IP address 192.0.2.44/32

        • A ByteMatchSet that matches BadBot in the User-Agent header

        Further, you specify a RateLimit of 1,000.

        You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer blocks the requests.

        As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

        • A ByteMatchSet with FieldToMatch of URI

        • A PositionalConstraint of STARTS_WITH

        • A TargetString of login

        Further, you specify a RateLimit of 1,000.

        By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

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

        1. Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

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

        3. Submit a CreateRateBasedRule request.

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

        5. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule.

        6. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL.

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

        Parameters:
        createRateBasedRuleRequest -
        Returns:
        Result of the CreateRateBasedRule operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafDisallowedNameException - The name specified is invalid.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafTagOperationException
        WafTagOperationInternalErrorException
        WafBadRequestException
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createRateBasedRule

        default CreateRateBasedRuleResponse createRateBasedRule​(Consumer<CreateRateBasedRuleRequest.Builder> createRateBasedRuleRequest)
                                                         throws WafStaleDataException,
                                                                WafInternalErrorException,
                                                                WafDisallowedNameException,
                                                                WafInvalidParameterException,
                                                                WafLimitsExceededException,
                                                                WafTagOperationException,
                                                                WafTagOperationInternalErrorException,
                                                                WafBadRequestException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                WafException

        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.

        Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit.

        If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the conditions to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

        • An IPSet that matches the IP address 192.0.2.44/32

        • A ByteMatchSet that matches BadBot in the User-Agent header

        Further, you specify a RateLimit of 1,000.

        You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer blocks the requests.

        As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

        • A ByteMatchSet with FieldToMatch of URI

        • A PositionalConstraint of STARTS_WITH

        • A TargetString of login

        Further, you specify a RateLimit of 1,000.

        By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

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

        1. Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

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

        3. Submit a CreateRateBasedRule request.

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

        5. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule.

        6. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL.

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


        This is a convenience which creates an instance of the CreateRateBasedRuleRequest.Builder avoiding the need to create one manually via CreateRateBasedRuleRequest.builder()

        Parameters:
        createRateBasedRuleRequest - A Consumer that will call methods on CreateRateBasedRuleRequest.Builder to create a request.
        Returns:
        Result of the CreateRateBasedRule operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafDisallowedNameException - The name specified is invalid.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafTagOperationException
        WafTagOperationInternalErrorException
        WafBadRequestException
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createRegexMatchSet

        default CreateRegexMatchSetResponse createRegexMatchSet​(CreateRegexMatchSetRequest createRegexMatchSetRequest)
                                                         throws WafStaleDataException,
                                                                WafInternalErrorException,
                                                                WafDisallowedNameException,
                                                                WafLimitsExceededException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                WafException

        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.

        Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

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

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

        2. Submit a CreateRegexMatchSet request.

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

        4. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for.

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

        Parameters:
        createRegexMatchSetRequest -
        Returns:
        Result of the CreateRegexMatchSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafDisallowedNameException - The name specified is invalid.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createRegexPatternSet

        default CreateRegexPatternSetResponse createRegexPatternSet​(CreateRegexPatternSetRequest createRegexPatternSetRequest)
                                                             throws WafStaleDataException,
                                                                    WafInternalErrorException,
                                                                    WafDisallowedNameException,
                                                                    WafLimitsExceededException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    WafException

        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.

        Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

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

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

        2. Submit a CreateRegexPatternSet request.

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

        4. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.

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

        Parameters:
        createRegexPatternSetRequest -
        Returns:
        Result of the CreateRegexPatternSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafDisallowedNameException - The name specified is invalid.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createRule

        default CreateRuleResponse createRule​(CreateRuleRequest createRuleRequest)
                                       throws WafStaleDataException,
                                              WafInternalErrorException,
                                              WafDisallowedNameException,
                                              WafInvalidParameterException,
                                              WafLimitsExceededException,
                                              WafTagOperationException,
                                              WafTagOperationInternalErrorException,
                                              WafBadRequestException,
                                              AwsServiceException,
                                              SdkClientException,
                                              WafException

        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.

        Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule:

        • An IPSet that matches the IP address 192.0.2.44/32

        • A ByteMatchSet that matches BadBot in the User-Agent header

        You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.

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

        1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

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

        3. Submit a CreateRule request.

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

        5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

        6. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.

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

        Parameters:
        createRuleRequest -
        Returns:
        Result of the CreateRule operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafDisallowedNameException - The name specified is invalid.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafTagOperationException
        WafTagOperationInternalErrorException
        WafBadRequestException
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createRule

        default CreateRuleResponse createRule​(Consumer<CreateRuleRequest.Builder> createRuleRequest)
                                       throws WafStaleDataException,
                                              WafInternalErrorException,
                                              WafDisallowedNameException,
                                              WafInvalidParameterException,
                                              WafLimitsExceededException,
                                              WafTagOperationException,
                                              WafTagOperationInternalErrorException,
                                              WafBadRequestException,
                                              AwsServiceException,
                                              SdkClientException,
                                              WafException

        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.

        Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule:

        • An IPSet that matches the IP address 192.0.2.44/32

        • A ByteMatchSet that matches BadBot in the User-Agent header

        You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.

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

        1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

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

        3. Submit a CreateRule request.

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

        5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

        6. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.

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


        This is a convenience which creates an instance of the CreateRuleRequest.Builder avoiding the need to create one manually via CreateRuleRequest.builder()

        Parameters:
        createRuleRequest - A Consumer that will call methods on CreateRuleRequest.Builder to create a request.
        Returns:
        Result of the CreateRule operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafDisallowedNameException - The name specified is invalid.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafTagOperationException
        WafTagOperationInternalErrorException
        WafBadRequestException
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createSizeConstraintSet

        default CreateSizeConstraintSetResponse createSizeConstraintSet​(CreateSizeConstraintSetRequest createSizeConstraintSetRequest)
                                                                 throws WafStaleDataException,
                                                                        WafInternalErrorException,
                                                                        WafInvalidAccountException,
                                                                        WafDisallowedNameException,
                                                                        WafInvalidParameterException,
                                                                        WafLimitsExceededException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        WafException

        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.

        Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.

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

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

        2. Submit a CreateSizeConstraintSet request.

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

        4. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

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

        Parameters:
        createSizeConstraintSetRequest -
        Returns:
        Result of the CreateSizeConstraintSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafDisallowedNameException - The name specified is invalid.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createSizeConstraintSet

        default CreateSizeConstraintSetResponse createSizeConstraintSet​(Consumer<CreateSizeConstraintSetRequest.Builder> createSizeConstraintSetRequest)
                                                                 throws WafStaleDataException,
                                                                        WafInternalErrorException,
                                                                        WafInvalidAccountException,
                                                                        WafDisallowedNameException,
                                                                        WafInvalidParameterException,
                                                                        WafLimitsExceededException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        WafException

        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.

        Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.

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

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

        2. Submit a CreateSizeConstraintSet request.

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

        4. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

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


        This is a convenience which creates an instance of the CreateSizeConstraintSetRequest.Builder avoiding the need to create one manually via CreateSizeConstraintSetRequest.builder()

        Parameters:
        createSizeConstraintSetRequest - A Consumer that will call methods on CreateSizeConstraintSetRequest.Builder to create a request.
        Returns:
        Result of the CreateSizeConstraintSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafDisallowedNameException - The name specified is invalid.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createSqlInjectionMatchSet

        default CreateSqlInjectionMatchSetResponse createSqlInjectionMatchSet​(CreateSqlInjectionMatchSetRequest createSqlInjectionMatchSetRequest)
                                                                       throws WafDisallowedNameException,
                                                                              WafInternalErrorException,
                                                                              WafInvalidAccountException,
                                                                              WafInvalidParameterException,
                                                                              WafStaleDataException,
                                                                              WafLimitsExceededException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              WafException

        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.

        Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

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

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

        2. Submit a CreateSqlInjectionMatchSet request.

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

        4. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.

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

        Parameters:
        createSqlInjectionMatchSetRequest - A request to create a SqlInjectionMatchSet.
        Returns:
        Result of the CreateSqlInjectionMatchSet operation returned by the service.
        Throws:
        WafDisallowedNameException - The name specified is invalid.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createSqlInjectionMatchSet

        default CreateSqlInjectionMatchSetResponse createSqlInjectionMatchSet​(Consumer<CreateSqlInjectionMatchSetRequest.Builder> createSqlInjectionMatchSetRequest)
                                                                       throws WafDisallowedNameException,
                                                                              WafInternalErrorException,
                                                                              WafInvalidAccountException,
                                                                              WafInvalidParameterException,
                                                                              WafStaleDataException,
                                                                              WafLimitsExceededException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              WafException

        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.

        Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

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

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

        2. Submit a CreateSqlInjectionMatchSet request.

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

        4. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.

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


        This is a convenience which creates an instance of the CreateSqlInjectionMatchSetRequest.Builder avoiding the need to create one manually via CreateSqlInjectionMatchSetRequest.builder()

        Parameters:
        createSqlInjectionMatchSetRequest - A Consumer that will call methods on CreateSqlInjectionMatchSetRequest.Builder to create a request. A request to create a SqlInjectionMatchSet.
        Returns:
        Result of the CreateSqlInjectionMatchSet operation returned by the service.
        Throws:
        WafDisallowedNameException - The name specified is invalid.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createWebACLMigrationStack

        default CreateWebAclMigrationStackResponse createWebACLMigrationStack​(CreateWebAclMigrationStackRequest createWebAclMigrationStackRequest)
                                                                       throws WafInternalErrorException,
                                                                              WafInvalidParameterException,
                                                                              WafInvalidOperationException,
                                                                              WafNonexistentItemException,
                                                                              WafEntityMigrationException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              WafException

        Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.

        This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF Developer Guide.

        Parameters:
        createWebAclMigrationStackRequest -
        Returns:
        Result of the CreateWebACLMigrationStack operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafEntityMigrationException - The operation failed due to a problem with the migration. The failure cause is provided in the exception, in the MigrationErrorType:

        • ENTITY_NOT_SUPPORTED - The web ACL has an unsupported entity but the IgnoreUnsupportedType is not set to true.

        • ENTITY_NOT_FOUND - The web ACL doesn't exist.

        • S3_BUCKET_NO_PERMISSION - You don't have permission to perform the PutObject action to the specified Amazon S3 bucket.

        • S3_BUCKET_NOT_ACCESSIBLE - The bucket policy doesn't allow AWS WAF to perform the PutObject action in the bucket.

        • S3_BUCKET_NOT_FOUND - The S3 bucket doesn't exist.

        • S3_BUCKET_INVALID_REGION - The S3 bucket is not in the same Region as the web ACL.

        • S3_INTERNAL_ERROR - AWS WAF failed to create the template in the S3 bucket for another reason.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createWebACLMigrationStack

        default CreateWebAclMigrationStackResponse createWebACLMigrationStack​(Consumer<CreateWebAclMigrationStackRequest.Builder> createWebAclMigrationStackRequest)
                                                                       throws WafInternalErrorException,
                                                                              WafInvalidParameterException,
                                                                              WafInvalidOperationException,
                                                                              WafNonexistentItemException,
                                                                              WafEntityMigrationException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              WafException

        Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.

        This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF Developer Guide.


        This is a convenience which creates an instance of the CreateWebAclMigrationStackRequest.Builder avoiding the need to create one manually via CreateWebAclMigrationStackRequest.builder()

        Parameters:
        createWebAclMigrationStackRequest - A Consumer that will call methods on CreateWebAclMigrationStackRequest.Builder to create a request.
        Returns:
        Result of the CreateWebACLMigrationStack operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafEntityMigrationException - The operation failed due to a problem with the migration. The failure cause is provided in the exception, in the MigrationErrorType:

        • ENTITY_NOT_SUPPORTED - The web ACL has an unsupported entity but the IgnoreUnsupportedType is not set to true.

        • ENTITY_NOT_FOUND - The web ACL doesn't exist.

        • S3_BUCKET_NO_PERMISSION - You don't have permission to perform the PutObject action to the specified Amazon S3 bucket.

        • S3_BUCKET_NOT_ACCESSIBLE - The bucket policy doesn't allow AWS WAF to perform the PutObject action in the bucket.

        • S3_BUCKET_NOT_FOUND - The S3 bucket doesn't exist.

        • S3_BUCKET_INVALID_REGION - The S3 bucket is not in the same Region as the web ACL.

        • S3_INTERNAL_ERROR - AWS WAF failed to create the template in the S3 bucket for another reason.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createXssMatchSet

        default CreateXssMatchSetResponse createXssMatchSet​(CreateXssMatchSetRequest createXssMatchSetRequest)
                                                     throws WafDisallowedNameException,
                                                            WafInternalErrorException,
                                                            WafInvalidAccountException,
                                                            WafInvalidParameterException,
                                                            WafStaleDataException,
                                                            WafLimitsExceededException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            WafException

        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.

        Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

        To create and configure an XssMatchSet, perform the following steps:

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

        2. Submit a CreateXssMatchSet request.

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

        4. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.

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

        Parameters:
        createXssMatchSetRequest - A request to create an XssMatchSet.
        Returns:
        Result of the CreateXssMatchSet operation returned by the service.
        Throws:
        WafDisallowedNameException - The name specified is invalid.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • createXssMatchSet

        default CreateXssMatchSetResponse createXssMatchSet​(Consumer<CreateXssMatchSetRequest.Builder> createXssMatchSetRequest)
                                                     throws WafDisallowedNameException,
                                                            WafInternalErrorException,
                                                            WafInvalidAccountException,
                                                            WafInvalidParameterException,
                                                            WafStaleDataException,
                                                            WafLimitsExceededException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            WafException

        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.

        Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

        To create and configure an XssMatchSet, perform the following steps:

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

        2. Submit a CreateXssMatchSet request.

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

        4. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.

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


        This is a convenience which creates an instance of the CreateXssMatchSetRequest.Builder avoiding the need to create one manually via CreateXssMatchSetRequest.builder()

        Parameters:
        createXssMatchSetRequest - A Consumer that will call methods on CreateXssMatchSetRequest.Builder to create a request. A request to create an XssMatchSet.
        Returns:
        Result of the CreateXssMatchSet operation returned by the service.
        Throws:
        WafDisallowedNameException - The name specified is invalid.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteByteMatchSet

        default DeleteByteMatchSetResponse deleteByteMatchSet​(DeleteByteMatchSetRequest deleteByteMatchSetRequest)
                                                       throws WafInternalErrorException,
                                                              WafInvalidAccountException,
                                                              WafNonexistentItemException,
                                                              WafReferencedItemException,
                                                              WafStaleDataException,
                                                              WafNonEmptyEntityException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              WafException

        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 ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters).

        If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.

        To permanently delete a ByteMatchSet, perform the following steps:

        1. Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.

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

        3. Submit a DeleteByteMatchSet request.

        Parameters:
        deleteByteMatchSetRequest -
        Returns:
        Result of the DeleteByteMatchSet operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:

        • You tried to delete a WebACL that still contains one or more Rule objects.

        • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

        • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

        • You tried to delete an IPSet that references one or more IP addresses.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteGeoMatchSet

        default DeleteGeoMatchSetResponse deleteGeoMatchSet​(DeleteGeoMatchSetRequest deleteGeoMatchSetRequest)
                                                     throws WafStaleDataException,
                                                            WafInternalErrorException,
                                                            WafInvalidAccountException,
                                                            WafNonexistentItemException,
                                                            WafReferencedItemException,
                                                            WafNonEmptyEntityException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            WafException

        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 GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries.

        If you just want to remove a GeoMatchSet from a Rule, use UpdateRule.

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

        1. Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet.

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

        3. Submit a DeleteGeoMatchSet request.

        Parameters:
        deleteGeoMatchSetRequest -
        Returns:
        Result of the DeleteGeoMatchSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:

        • You tried to delete a WebACL that still contains one or more Rule objects.

        • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

        • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

        • You tried to delete an IPSet that references one or more IP addresses.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteIPSet

        default DeleteIpSetResponse deleteIPSet​(DeleteIpSetRequest deleteIpSetRequest)
                                         throws WafStaleDataException,
                                                WafInternalErrorException,
                                                WafInvalidAccountException,
                                                WafNonexistentItemException,
                                                WafReferencedItemException,
                                                WafNonEmptyEntityException,
                                                AwsServiceException,
                                                SdkClientException,
                                                WafException

        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 an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses.

        If you just want to remove an IPSet from a Rule, use UpdateRule.

        To permanently delete an IPSet from AWS WAF, perform the following steps:

        1. Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.

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

        3. Submit a DeleteIPSet request.

        Parameters:
        deleteIpSetRequest -
        Returns:
        Result of the DeleteIPSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:

        • You tried to delete a WebACL that still contains one or more Rule objects.

        • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

        • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

        • You tried to delete an IPSet that references one or more IP addresses.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteRegexMatchSet

        default DeleteRegexMatchSetResponse deleteRegexMatchSet​(DeleteRegexMatchSetRequest deleteRegexMatchSetRequest)
                                                         throws WafInternalErrorException,
                                                                WafInvalidAccountException,
                                                                WafNonexistentItemException,
                                                                WafReferencedItemException,
                                                                WafStaleDataException,
                                                                WafNonEmptyEntityException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                WafException

        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 RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters).

        If you just want to remove a RegexMatchSet from a Rule, use UpdateRule.

        To permanently delete a RegexMatchSet, perform the following steps:

        1. Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet.

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

        3. Submit a DeleteRegexMatchSet request.

        Parameters:
        deleteRegexMatchSetRequest -
        Returns:
        Result of the DeleteRegexMatchSet operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:

        • You tried to delete a WebACL that still contains one or more Rule objects.

        • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

        • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

        • You tried to delete an IPSet that references one or more IP addresses.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteRuleGroup

        default DeleteRuleGroupResponse deleteRuleGroup​(DeleteRuleGroupRequest deleteRuleGroupRequest)
                                                 throws WafStaleDataException,
                                                        WafInternalErrorException,
                                                        WafNonexistentItemException,
                                                        WafReferencedItemException,
                                                        WafNonEmptyEntityException,
                                                        WafInvalidOperationException,
                                                        WafTagOperationException,
                                                        WafTagOperationInternalErrorException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        WafException

        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 RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules.

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

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

        1. Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup.

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

        3. Submit a DeleteRuleGroup request.

        Parameters:
        deleteRuleGroupRequest -
        Returns:
        Result of the DeleteRuleGroup operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:

        • You tried to delete a WebACL that still contains one or more Rule objects.

        • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

        • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

        • You tried to delete an IPSet that references one or more IP addresses.

        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafTagOperationException
        WafTagOperationInternalErrorException
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteSizeConstraintSet

        default DeleteSizeConstraintSetResponse deleteSizeConstraintSet​(DeleteSizeConstraintSetRequest deleteSizeConstraintSetRequest)
                                                                 throws WafStaleDataException,
                                                                        WafInternalErrorException,
                                                                        WafInvalidAccountException,
                                                                        WafNonexistentItemException,
                                                                        WafReferencedItemException,
                                                                        WafNonEmptyEntityException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        WafException

        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 SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters).

        If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.

        To permanently delete a SizeConstraintSet, perform the following steps:

        1. Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet.

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

        3. Submit a DeleteSizeConstraintSet request.

        Parameters:
        deleteSizeConstraintSetRequest -
        Returns:
        Result of the DeleteSizeConstraintSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:

        • You tried to delete a WebACL that still contains one or more Rule objects.

        • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

        • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

        • You tried to delete an IPSet that references one or more IP addresses.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteXssMatchSet

        default DeleteXssMatchSetResponse deleteXssMatchSet​(DeleteXssMatchSetRequest deleteXssMatchSetRequest)
                                                     throws WafInternalErrorException,
                                                            WafInvalidAccountException,
                                                            WafNonexistentItemException,
                                                            WafReferencedItemException,
                                                            WafStaleDataException,
                                                            WafNonEmptyEntityException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            WafException

        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 an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects.

        If you just want to remove an XssMatchSet from a Rule, use UpdateRule.

        To permanently delete an XssMatchSet from AWS WAF, perform the following steps:

        1. Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet.

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

        3. Submit a DeleteXssMatchSet request.

        Parameters:
        deleteXssMatchSetRequest - A request to delete an XssMatchSet from AWS WAF.
        Returns:
        Result of the DeleteXssMatchSet operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:

        • You tried to delete a WebACL that still contains one or more Rule objects.

        • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

        • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

        • You tried to delete an IPSet that references one or more IP addresses.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getChangeToken

        default GetChangeTokenResponse getChangeToken​(GetChangeTokenRequest getChangeTokenRequest)
                                               throws WafInternalErrorException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      WafException

        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.

        When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

        Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.

        When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.

        Parameters:
        getChangeTokenRequest -
        Returns:
        Result of the GetChangeToken operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getChangeToken

        default GetChangeTokenResponse getChangeToken​(Consumer<GetChangeTokenRequest.Builder> getChangeTokenRequest)
                                               throws WafInternalErrorException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      WafException

        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.

        When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

        Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.

        When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.


        This is a convenience which creates an instance of the GetChangeTokenRequest.Builder avoiding the need to create one manually via GetChangeTokenRequest.builder()

        Parameters:
        getChangeTokenRequest - A Consumer that will call methods on GetChangeTokenRequest.Builder to create a request.
        Returns:
        Result of the GetChangeToken operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getChangeToken

        default GetChangeTokenResponse getChangeToken()
                                               throws WafInternalErrorException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      WafException

        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.

        When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

        Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.

        When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.

        Returns:
        Result of the GetChangeToken operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        getChangeToken(GetChangeTokenRequest), AWS API Documentation
      • getChangeTokenStatus

        default GetChangeTokenStatusResponse getChangeTokenStatus​(GetChangeTokenStatusRequest getChangeTokenStatusRequest)
                                                           throws WafNonexistentItemException,
                                                                  WafInternalErrorException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  WafException

        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.

        Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values:

        • PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.

        • PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.

        • INSYNC: Propagation is complete.

        Parameters:
        getChangeTokenStatusRequest -
        Returns:
        Result of the GetChangeTokenStatus operation returned by the service.
        Throws:
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getRateBasedRuleManagedKeys

        default GetRateBasedRuleManagedKeysResponse getRateBasedRuleManagedKeys​(GetRateBasedRuleManagedKeysRequest getRateBasedRuleManagedKeysRequest)
                                                                         throws WafInternalErrorException,
                                                                                WafInvalidAccountException,
                                                                                WafNonexistentItemException,
                                                                                WafInvalidParameterException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                WafException

        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.

        Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.

        Parameters:
        getRateBasedRuleManagedKeysRequest -
        Returns:
        Result of the GetRateBasedRuleManagedKeys operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getRateBasedRuleManagedKeys

        default GetRateBasedRuleManagedKeysResponse getRateBasedRuleManagedKeys​(Consumer<GetRateBasedRuleManagedKeysRequest.Builder> getRateBasedRuleManagedKeysRequest)
                                                                         throws WafInternalErrorException,
                                                                                WafInvalidAccountException,
                                                                                WafNonexistentItemException,
                                                                                WafInvalidParameterException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                WafException

        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.

        Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.


        This is a convenience which creates an instance of the GetRateBasedRuleManagedKeysRequest.Builder avoiding the need to create one manually via GetRateBasedRuleManagedKeysRequest.builder()

        Parameters:
        getRateBasedRuleManagedKeysRequest - A Consumer that will call methods on GetRateBasedRuleManagedKeysRequest.Builder to create a request.
        Returns:
        Result of the GetRateBasedRuleManagedKeys operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getSampledRequests

        default GetSampledRequestsResponse getSampledRequests​(GetSampledRequestsRequest getSampledRequestsRequest)
                                                       throws WafNonexistentItemException,
                                                              WafInternalErrorException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              WafException

        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.

        Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

        GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

        Parameters:
        getSampledRequestsRequest -
        Returns:
        Result of the GetSampledRequests operation returned by the service.
        Throws:
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getSampledRequests

        default GetSampledRequestsResponse getSampledRequests​(Consumer<GetSampledRequestsRequest.Builder> getSampledRequestsRequest)
                                                       throws WafNonexistentItemException,
                                                              WafInternalErrorException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              WafException

        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.

        Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

        GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.


        This is a convenience which creates an instance of the GetSampledRequestsRequest.Builder avoiding the need to create one manually via GetSampledRequestsRequest.builder()

        Parameters:
        getSampledRequestsRequest - A Consumer that will call methods on GetSampledRequestsRequest.Builder to create a request.
        Returns:
        Result of the GetSampledRequests operation returned by the service.
        Throws:
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listActivatedRulesInRuleGroup

        default ListActivatedRulesInRuleGroupResponse listActivatedRulesInRuleGroup​(ListActivatedRulesInRuleGroupRequest listActivatedRulesInRuleGroupRequest)
                                                                             throws WafInternalErrorException,
                                                                                    WafNonexistentItemException,
                                                                                    WafInvalidParameterException,
                                                                                    AwsServiceException,
                                                                                    SdkClientException,
                                                                                    WafException

        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.

        Returns an array of ActivatedRule objects.

        Parameters:
        listActivatedRulesInRuleGroupRequest -
        Returns:
        Result of the ListActivatedRulesInRuleGroup operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listLoggingConfigurations

        default ListLoggingConfigurationsResponse listLoggingConfigurations​(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest)
                                                                     throws WafInternalErrorException,
                                                                            WafNonexistentItemException,
                                                                            WafInvalidParameterException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            WafException

        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.

        Returns an array of LoggingConfiguration objects.

        Parameters:
        listLoggingConfigurationsRequest -
        Returns:
        Result of the ListLoggingConfigurations operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listTagsForResource

        default ListTagsForResourceResponse listTagsForResource​(ListTagsForResourceRequest listTagsForResourceRequest)
                                                         throws WafInternalErrorException,
                                                                WafInvalidParameterException,
                                                                WafNonexistentItemException,
                                                                WafBadRequestException,
                                                                WafTagOperationException,
                                                                WafTagOperationInternalErrorException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                WafException

        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.

        Retrieves the tags associated with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

        Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.

        Parameters:
        listTagsForResourceRequest -
        Returns:
        Result of the ListTagsForResource operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafBadRequestException
        WafTagOperationException
        WafTagOperationInternalErrorException
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putLoggingConfiguration

        default PutLoggingConfigurationResponse putLoggingConfiguration​(PutLoggingConfigurationRequest putLoggingConfigurationRequest)
                                                                 throws WafInternalErrorException,
                                                                        WafNonexistentItemException,
                                                                        WafStaleDataException,
                                                                        WafServiceLinkedRoleErrorException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        WafException

        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.

        Associates a LoggingConfiguration with a specified web ACL.

        You can access information about all traffic that AWS WAF inspects using the following steps:

        1. Create an Amazon Kinesis Data Firehose.

          Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

          Do not create the data firehose using a Kinesis stream as your source.

        2. Associate that firehose to your web ACL using a PutLoggingConfiguration request.

        When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

        Parameters:
        putLoggingConfigurationRequest -
        Returns:
        Result of the PutLoggingConfiguration operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafServiceLinkedRoleErrorException - AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putLoggingConfiguration

        default PutLoggingConfigurationResponse putLoggingConfiguration​(Consumer<PutLoggingConfigurationRequest.Builder> putLoggingConfigurationRequest)
                                                                 throws WafInternalErrorException,
                                                                        WafNonexistentItemException,
                                                                        WafStaleDataException,
                                                                        WafServiceLinkedRoleErrorException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        WafException

        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.

        Associates a LoggingConfiguration with a specified web ACL.

        You can access information about all traffic that AWS WAF inspects using the following steps:

        1. Create an Amazon Kinesis Data Firehose.

          Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

          Do not create the data firehose using a Kinesis stream as your source.

        2. Associate that firehose to your web ACL using a PutLoggingConfiguration request.

        When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.


        This is a convenience which creates an instance of the PutLoggingConfigurationRequest.Builder avoiding the need to create one manually via PutLoggingConfigurationRequest.builder()

        Parameters:
        putLoggingConfigurationRequest - A Consumer that will call methods on PutLoggingConfigurationRequest.Builder to create a request.
        Returns:
        Result of the PutLoggingConfiguration operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafServiceLinkedRoleErrorException - AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putPermissionPolicy

        default PutPermissionPolicyResponse putPermissionPolicy​(PutPermissionPolicyRequest putPermissionPolicyRequest)
                                                         throws WafInternalErrorException,
                                                                WafStaleDataException,
                                                                WafNonexistentItemException,
                                                                WafInvalidPermissionPolicyException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                WafException

        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.

        Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.

        The PutPermissionPolicy is subject to the following restrictions:

        • You can attach only one policy with each PutPermissionPolicy request.

        • The policy must include an Effect, Action and Principal.

        • Effect must specify Allow.

        • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

        • The policy cannot include a Resource parameter.

        • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

        • The user making the request must be the owner of the RuleGroup.

        • Your policy must be composed using IAM Policy version 2012-10-17.

        For more information, see IAM Policies.

        An example of a valid policy parameter is shown in the Examples section below.

        Parameters:
        putPermissionPolicyRequest -
        Returns:
        Result of the PutPermissionPolicy operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafInvalidPermissionPolicyException - The operation failed because the specified policy is not in the proper format.

        The policy is subject to the following restrictions:

        • You can attach only one policy with each PutPermissionPolicy request.

        • The policy must include an Effect, Action and Principal.

        • Effect must specify Allow.

        • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

        • The policy cannot include a Resource parameter.

        • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

        • The user making the request must be the owner of the RuleGroup.

        • Your policy must be composed using IAM Policy version 2012-10-17.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putPermissionPolicy

        default PutPermissionPolicyResponse putPermissionPolicy​(Consumer<PutPermissionPolicyRequest.Builder> putPermissionPolicyRequest)
                                                         throws WafInternalErrorException,
                                                                WafStaleDataException,
                                                                WafNonexistentItemException,
                                                                WafInvalidPermissionPolicyException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                WafException

        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.

        Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.

        The PutPermissionPolicy is subject to the following restrictions:

        • You can attach only one policy with each PutPermissionPolicy request.

        • The policy must include an Effect, Action and Principal.

        • Effect must specify Allow.

        • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

        • The policy cannot include a Resource parameter.

        • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

        • The user making the request must be the owner of the RuleGroup.

        • Your policy must be composed using IAM Policy version 2012-10-17.

        For more information, see IAM Policies.

        An example of a valid policy parameter is shown in the Examples section below.


        This is a convenience which creates an instance of the PutPermissionPolicyRequest.Builder avoiding the need to create one manually via PutPermissionPolicyRequest.builder()

        Parameters:
        putPermissionPolicyRequest - A Consumer that will call methods on PutPermissionPolicyRequest.Builder to create a request.
        Returns:
        Result of the PutPermissionPolicy operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafInvalidPermissionPolicyException - The operation failed because the specified policy is not in the proper format.

        The policy is subject to the following restrictions:

        • You can attach only one policy with each PutPermissionPolicy request.

        • The policy must include an Effect, Action and Principal.

        • Effect must specify Allow.

        • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

        • The policy cannot include a Resource parameter.

        • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

        • The user making the request must be the owner of the RuleGroup.

        • Your policy must be composed using IAM Policy version 2012-10-17.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • tagResource

        default TagResourceResponse tagResource​(TagResourceRequest tagResourceRequest)
                                         throws WafInternalErrorException,
                                                WafInvalidParameterException,
                                                WafLimitsExceededException,
                                                WafNonexistentItemException,
                                                WafBadRequestException,
                                                WafTagOperationException,
                                                WafTagOperationInternalErrorException,
                                                AwsServiceException,
                                                SdkClientException,
                                                WafException

        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.

        Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

        Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.

        Parameters:
        tagResourceRequest -
        Returns:
        Result of the TagResource operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafBadRequestException
        WafTagOperationException
        WafTagOperationInternalErrorException
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • tagResource

        default TagResourceResponse tagResource​(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                         throws WafInternalErrorException,
                                                WafInvalidParameterException,
                                                WafLimitsExceededException,
                                                WafNonexistentItemException,
                                                WafBadRequestException,
                                                WafTagOperationException,
                                                WafTagOperationInternalErrorException,
                                                AwsServiceException,
                                                SdkClientException,
                                                WafException

        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.

        Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

        Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.


        This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

        Parameters:
        tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
        Returns:
        Result of the TagResource operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafBadRequestException
        WafTagOperationException
        WafTagOperationInternalErrorException
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateByteMatchSet

        default UpdateByteMatchSetResponse updateByteMatchSet​(UpdateByteMatchSetRequest updateByteMatchSetRequest)
                                                       throws WafInternalErrorException,
                                                              WafInvalidAccountException,
                                                              WafInvalidOperationException,
                                                              WafInvalidParameterException,
                                                              WafNonexistentContainerException,
                                                              WafNonexistentItemException,
                                                              WafStaleDataException,
                                                              WafLimitsExceededException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              WafException

        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.

        Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

        • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

        • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

        • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

        • Where to look, such as at the beginning or the end of a query string.

        • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

        For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

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

        1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

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

        3. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

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

        Parameters:
        updateByteMatchSetRequest -
        Returns:
        Result of the UpdateByteMatchSet operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateByteMatchSet

        default UpdateByteMatchSetResponse updateByteMatchSet​(Consumer<UpdateByteMatchSetRequest.Builder> updateByteMatchSetRequest)
                                                       throws WafInternalErrorException,
                                                              WafInvalidAccountException,
                                                              WafInvalidOperationException,
                                                              WafInvalidParameterException,
                                                              WafNonexistentContainerException,
                                                              WafNonexistentItemException,
                                                              WafStaleDataException,
                                                              WafLimitsExceededException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              WafException

        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.

        Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

        • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

        • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

        • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

        • Where to look, such as at the beginning or the end of a query string.

        • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

        For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

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

        1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

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

        3. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

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


        This is a convenience which creates an instance of the UpdateByteMatchSetRequest.Builder avoiding the need to create one manually via UpdateByteMatchSetRequest.builder()

        Parameters:
        updateByteMatchSetRequest - A Consumer that will call methods on UpdateByteMatchSetRequest.Builder to create a request.
        Returns:
        Result of the UpdateByteMatchSet operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateGeoMatchSet

        default UpdateGeoMatchSetResponse updateGeoMatchSet​(UpdateGeoMatchSetRequest updateGeoMatchSetRequest)
                                                     throws WafStaleDataException,
                                                            WafInternalErrorException,
                                                            WafInvalidAccountException,
                                                            WafInvalidOperationException,
                                                            WafInvalidParameterException,
                                                            WafNonexistentContainerException,
                                                            WafNonexistentItemException,
                                                            WafReferencedItemException,
                                                            WafLimitsExceededException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            WafException

        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.

        Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values:

        • Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one.

        • The Type. The only valid value for Type is Country.

        • The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value.

        To create and configure an GeoMatchSet, perform the following steps:

        1. Submit a CreateGeoMatchSet request.

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

        3. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for.

        When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country 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.

        Parameters:
        updateGeoMatchSetRequest -
        Returns:
        Result of the UpdateGeoMatchSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateGeoMatchSet

        default UpdateGeoMatchSetResponse updateGeoMatchSet​(Consumer<UpdateGeoMatchSetRequest.Builder> updateGeoMatchSetRequest)
                                                     throws WafStaleDataException,
                                                            WafInternalErrorException,
                                                            WafInvalidAccountException,
                                                            WafInvalidOperationException,
                                                            WafInvalidParameterException,
                                                            WafNonexistentContainerException,
                                                            WafNonexistentItemException,
                                                            WafReferencedItemException,
                                                            WafLimitsExceededException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            WafException

        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.

        Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values:

        • Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one.

        • The Type. The only valid value for Type is Country.

        • The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value.

        To create and configure an GeoMatchSet, perform the following steps:

        1. Submit a CreateGeoMatchSet request.

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

        3. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for.

        When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country 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.


        This is a convenience which creates an instance of the UpdateGeoMatchSetRequest.Builder avoiding the need to create one manually via UpdateGeoMatchSetRequest.builder()

        Parameters:
        updateGeoMatchSetRequest - A Consumer that will call methods on UpdateGeoMatchSetRequest.Builder to create a request.
        Returns:
        Result of the UpdateGeoMatchSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateIPSet

        default UpdateIpSetResponse updateIPSet​(UpdateIpSetRequest updateIpSetRequest)
                                         throws WafStaleDataException,
                                                WafInternalErrorException,
                                                WafInvalidAccountException,
                                                WafInvalidOperationException,
                                                WafInvalidParameterException,
                                                WafNonexistentContainerException,
                                                WafNonexistentItemException,
                                                WafReferencedItemException,
                                                WafLimitsExceededException,
                                                AwsServiceException,
                                                SdkClientException,
                                                WafException

        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.

        Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:

        • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

        • The IP address version, IPv4 or IPv6.

        • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

        AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

        IPv6 addresses can be represented using any of the following formats:

        • 1111:0000:0000:0000:0000:0000:0000:0111/128

        • 1111:0:0:0:0:0:0:0111/128

        • 1111::0111/128

        • 1111::111/128

        You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

        To create and configure an IPSet, perform the following steps:

        1. Submit a CreateIPSet request.

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

        3. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

        When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

        You can insert a maximum of 1000 addresses in a single request.

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

        Parameters:
        updateIpSetRequest -
        Returns:
        Result of the UpdateIPSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateIPSet

        default UpdateIpSetResponse updateIPSet​(Consumer<UpdateIpSetRequest.Builder> updateIpSetRequest)
                                         throws WafStaleDataException,
                                                WafInternalErrorException,
                                                WafInvalidAccountException,
                                                WafInvalidOperationException,
                                                WafInvalidParameterException,
                                                WafNonexistentContainerException,
                                                WafNonexistentItemException,
                                                WafReferencedItemException,
                                                WafLimitsExceededException,
                                                AwsServiceException,
                                                SdkClientException,
                                                WafException

        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.

        Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:

        • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

        • The IP address version, IPv4 or IPv6.

        • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

        AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

        IPv6 addresses can be represented using any of the following formats:

        • 1111:0000:0000:0000:0000:0000:0000:0111/128

        • 1111:0:0:0:0:0:0:0111/128

        • 1111::0111/128

        • 1111::111/128

        You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

        To create and configure an IPSet, perform the following steps:

        1. Submit a CreateIPSet request.

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

        3. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

        When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

        You can insert a maximum of 1000 addresses in a single request.

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


        This is a convenience which creates an instance of the UpdateIpSetRequest.Builder avoiding the need to create one manually via UpdateIpSetRequest.builder()

        Parameters:
        updateIpSetRequest - A Consumer that will call methods on UpdateIpSetRequest.Builder to create a request.
        Returns:
        Result of the UpdateIPSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateRateBasedRule

        default UpdateRateBasedRuleResponse updateRateBasedRule​(UpdateRateBasedRuleRequest updateRateBasedRuleRequest)
                                                         throws WafStaleDataException,
                                                                WafInternalErrorException,
                                                                WafInvalidAccountException,
                                                                WafInvalidOperationException,
                                                                WafInvalidParameterException,
                                                                WafNonexistentContainerException,
                                                                WafNonexistentItemException,
                                                                WafReferencedItemException,
                                                                WafLimitsExceededException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                WafException

        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.

        Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule.

        Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule.

        If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

        • An IPSet that matches the IP address 192.0.2.44/32

        • A ByteMatchSet that matches BadBot in the User-Agent header

        Further, you specify a RateLimit of 1,000.

        You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests.

        As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

        • A ByteMatchSet with FieldToMatch of URI

        • A PositionalConstraint of STARTS_WITH

        • A TargetString of login

        Further, you specify a RateLimit of 1,000.

        By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

        Parameters:
        updateRateBasedRuleRequest -
        Returns:
        Result of the UpdateRateBasedRule operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateRateBasedRule

        default UpdateRateBasedRuleResponse updateRateBasedRule​(Consumer<UpdateRateBasedRuleRequest.Builder> updateRateBasedRuleRequest)
                                                         throws WafStaleDataException,
                                                                WafInternalErrorException,
                                                                WafInvalidAccountException,
                                                                WafInvalidOperationException,
                                                                WafInvalidParameterException,
                                                                WafNonexistentContainerException,
                                                                WafNonexistentItemException,
                                                                WafReferencedItemException,
                                                                WafLimitsExceededException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                WafException

        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.

        Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule.

        Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule.

        If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

        • An IPSet that matches the IP address 192.0.2.44/32

        • A ByteMatchSet that matches BadBot in the User-Agent header

        Further, you specify a RateLimit of 1,000.

        You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests.

        As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

        • A ByteMatchSet with FieldToMatch of URI

        • A PositionalConstraint of STARTS_WITH

        • A TargetString of login

        Further, you specify a RateLimit of 1,000.

        By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.


        This is a convenience which creates an instance of the UpdateRateBasedRuleRequest.Builder avoiding the need to create one manually via UpdateRateBasedRuleRequest.builder()

        Parameters:
        updateRateBasedRuleRequest - A Consumer that will call methods on UpdateRateBasedRuleRequest.Builder to create a request.
        Returns:
        Result of the UpdateRateBasedRule operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateRegexMatchSet

        default UpdateRegexMatchSetResponse updateRegexMatchSet​(UpdateRegexMatchSetRequest updateRegexMatchSetRequest)
                                                         throws WafStaleDataException,
                                                                WafInternalErrorException,
                                                                WafDisallowedNameException,
                                                                WafLimitsExceededException,
                                                                WafNonexistentItemException,
                                                                WafNonexistentContainerException,
                                                                WafInvalidOperationException,
                                                                WafInvalidAccountException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                WafException

        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.

        Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values:

        • Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one.

        • The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header.

        • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

        • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

        For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

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

        1. Create a RegexMatchSet. For more information, see CreateRegexMatchSet.

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

        3. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for.

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

        Parameters:
        updateRegexMatchSetRequest -
        Returns:
        Result of the UpdateRegexMatchSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafDisallowedNameException - The name specified is invalid.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateRegexMatchSet

        default UpdateRegexMatchSetResponse updateRegexMatchSet​(Consumer<UpdateRegexMatchSetRequest.Builder> updateRegexMatchSetRequest)
                                                         throws WafStaleDataException,
                                                                WafInternalErrorException,
                                                                WafDisallowedNameException,
                                                                WafLimitsExceededException,
                                                                WafNonexistentItemException,
                                                                WafNonexistentContainerException,
                                                                WafInvalidOperationException,
                                                                WafInvalidAccountException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                WafException

        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.

        Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values:

        • Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one.

        • The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header.

        • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

        • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

        For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

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

        1. Create a RegexMatchSet. For more information, see CreateRegexMatchSet.

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

        3. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for.

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


        This is a convenience which creates an instance of the UpdateRegexMatchSetRequest.Builder avoiding the need to create one manually via UpdateRegexMatchSetRequest.builder()

        Parameters:
        updateRegexMatchSetRequest - A Consumer that will call methods on UpdateRegexMatchSetRequest.Builder to create a request.
        Returns:
        Result of the UpdateRegexMatchSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafDisallowedNameException - The name specified is invalid.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateRegexPatternSet

        default UpdateRegexPatternSetResponse updateRegexPatternSet​(UpdateRegexPatternSetRequest updateRegexPatternSetRequest)
                                                             throws WafStaleDataException,
                                                                    WafInternalErrorException,
                                                                    WafLimitsExceededException,
                                                                    WafNonexistentItemException,
                                                                    WafNonexistentContainerException,
                                                                    WafInvalidOperationException,
                                                                    WafInvalidAccountException,
                                                                    WafInvalidRegexPatternException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    WafException

        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.

        Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values:

        • Whether to insert or delete the RegexPatternString.

        • The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.

        For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to:

        • BadBot

        • BadB0t

        • B@dBot

        • B@dB0t

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

        1. Create a RegexPatternSet. For more information, see CreateRegexPatternSet.

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

        3. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for.

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

        Parameters:
        updateRegexPatternSetRequest -
        Returns:
        Result of the UpdateRegexPatternSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidRegexPatternException - The regular expression (regex) you specified in RegexPatternString is invalid.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateRegexPatternSet

        default UpdateRegexPatternSetResponse updateRegexPatternSet​(Consumer<UpdateRegexPatternSetRequest.Builder> updateRegexPatternSetRequest)
                                                             throws WafStaleDataException,
                                                                    WafInternalErrorException,
                                                                    WafLimitsExceededException,
                                                                    WafNonexistentItemException,
                                                                    WafNonexistentContainerException,
                                                                    WafInvalidOperationException,
                                                                    WafInvalidAccountException,
                                                                    WafInvalidRegexPatternException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    WafException

        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.

        Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values:

        • Whether to insert or delete the RegexPatternString.

        • The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.

        For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to:

        • BadBot

        • BadB0t

        • B@dBot

        • B@dB0t

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

        1. Create a RegexPatternSet. For more information, see CreateRegexPatternSet.

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

        3. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for.

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


        This is a convenience which creates an instance of the UpdateRegexPatternSetRequest.Builder avoiding the need to create one manually via UpdateRegexPatternSetRequest.builder()

        Parameters:
        updateRegexPatternSetRequest - A Consumer that will call methods on UpdateRegexPatternSetRequest.Builder to create a request.
        Returns:
        Result of the UpdateRegexPatternSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidRegexPatternException - The regular expression (regex) you specified in RegexPatternString is invalid.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateRule

        default UpdateRuleResponse updateRule​(UpdateRuleRequest updateRuleRequest)
                                       throws WafStaleDataException,
                                              WafInternalErrorException,
                                              WafInvalidAccountException,
                                              WafInvalidOperationException,
                                              WafInvalidParameterException,
                                              WafNonexistentContainerException,
                                              WafNonexistentItemException,
                                              WafReferencedItemException,
                                              WafLimitsExceededException,
                                              AwsServiceException,
                                              SdkClientException,
                                              WafException

        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.

        Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule:

        • A ByteMatchSet that matches the value BadBot in the User-Agent header

        • An IPSet that matches the IP address 192.0.2.44

        You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.

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

        1. Create and update the predicates that you want to include in the Rule.

        2. Create the Rule. See CreateRule.

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

        4. Submit an UpdateRule request to add predicates to the Rule.

        5. Create and update a WebACL that contains the Rule. See CreateWebACL.

        If you want to replace one ByteMatchSet or IPSet 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.

        Parameters:
        updateRuleRequest -
        Returns:
        Result of the UpdateRule operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateRule

        default UpdateRuleResponse updateRule​(Consumer<UpdateRuleRequest.Builder> updateRuleRequest)
                                       throws WafStaleDataException,
                                              WafInternalErrorException,
                                              WafInvalidAccountException,
                                              WafInvalidOperationException,
                                              WafInvalidParameterException,
                                              WafNonexistentContainerException,
                                              WafNonexistentItemException,
                                              WafReferencedItemException,
                                              WafLimitsExceededException,
                                              AwsServiceException,
                                              SdkClientException,
                                              WafException

        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.

        Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule:

        • A ByteMatchSet that matches the value BadBot in the User-Agent header

        • An IPSet that matches the IP address 192.0.2.44

        You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.

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

        1. Create and update the predicates that you want to include in the Rule.

        2. Create the Rule. See CreateRule.

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

        4. Submit an UpdateRule request to add predicates to the Rule.

        5. Create and update a WebACL that contains the Rule. See CreateWebACL.

        If you want to replace one ByteMatchSet or IPSet 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.


        This is a convenience which creates an instance of the UpdateRuleRequest.Builder avoiding the need to create one manually via UpdateRuleRequest.builder()

        Parameters:
        updateRuleRequest - A Consumer that will call methods on UpdateRuleRequest.Builder to create a request.
        Returns:
        Result of the UpdateRule operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateRuleGroup

        default UpdateRuleGroupResponse updateRuleGroup​(UpdateRuleGroupRequest updateRuleGroupRequest)
                                                 throws WafStaleDataException,
                                                        WafInternalErrorException,
                                                        WafNonexistentContainerException,
                                                        WafNonexistentItemException,
                                                        WafInvalidOperationException,
                                                        WafLimitsExceededException,
                                                        WafInvalidParameterException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        WafException

        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.

        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:

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

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

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

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

        Parameters:
        updateRuleGroupRequest -
        Returns:
        Result of the UpdateRuleGroup operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateRuleGroup

        default UpdateRuleGroupResponse updateRuleGroup​(Consumer<UpdateRuleGroupRequest.Builder> updateRuleGroupRequest)
                                                 throws WafStaleDataException,
                                                        WafInternalErrorException,
                                                        WafNonexistentContainerException,
                                                        WafNonexistentItemException,
                                                        WafInvalidOperationException,
                                                        WafLimitsExceededException,
                                                        WafInvalidParameterException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        WafException

        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.

        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:

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

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

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

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


        This is a convenience which creates an instance of the UpdateRuleGroupRequest.Builder avoiding the need to create one manually via UpdateRuleGroupRequest.builder()

        Parameters:
        updateRuleGroupRequest - A Consumer that will call methods on UpdateRuleGroupRequest.Builder to create a request.
        Returns:
        Result of the UpdateRuleGroup operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateSizeConstraintSet

        default UpdateSizeConstraintSetResponse updateSizeConstraintSet​(UpdateSizeConstraintSetRequest updateSizeConstraintSetRequest)
                                                                 throws WafStaleDataException,
                                                                        WafInternalErrorException,
                                                                        WafInvalidAccountException,
                                                                        WafInvalidOperationException,
                                                                        WafInvalidParameterException,
                                                                        WafNonexistentContainerException,
                                                                        WafNonexistentItemException,
                                                                        WafReferencedItemException,
                                                                        WafLimitsExceededException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        WafException

        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.

        Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values:

        • Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one.

        • The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header.

        • Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF.

          You can only specify a single type of TextTransformation.

        • A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.

        • The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

        For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

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

        1. Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.

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

        3. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

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

        Parameters:
        updateSizeConstraintSetRequest -
        Returns:
        Result of the UpdateSizeConstraintSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateSizeConstraintSet

        default UpdateSizeConstraintSetResponse updateSizeConstraintSet​(Consumer<UpdateSizeConstraintSetRequest.Builder> updateSizeConstraintSetRequest)
                                                                 throws WafStaleDataException,
                                                                        WafInternalErrorException,
                                                                        WafInvalidAccountException,
                                                                        WafInvalidOperationException,
                                                                        WafInvalidParameterException,
                                                                        WafNonexistentContainerException,
                                                                        WafNonexistentItemException,
                                                                        WafReferencedItemException,
                                                                        WafLimitsExceededException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        WafException

        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.

        Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values:

        • Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one.

        • The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header.

        • Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF.

          You can only specify a single type of TextTransformation.

        • A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.

        • The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

        For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

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

        1. Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.

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

        3. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

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


        This is a convenience which creates an instance of the UpdateSizeConstraintSetRequest.Builder avoiding the need to create one manually via UpdateSizeConstraintSetRequest.builder()

        Parameters:
        updateSizeConstraintSetRequest - A Consumer that will call methods on UpdateSizeConstraintSetRequest.Builder to create a request.
        Returns:
        Result of the UpdateSizeConstraintSet operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateSqlInjectionMatchSet

        default UpdateSqlInjectionMatchSetResponse updateSqlInjectionMatchSet​(UpdateSqlInjectionMatchSetRequest updateSqlInjectionMatchSetRequest)
                                                                       throws WafInternalErrorException,
                                                                              WafInvalidAccountException,
                                                                              WafInvalidOperationException,
                                                                              WafInvalidParameterException,
                                                                              WafNonexistentContainerException,
                                                                              WafNonexistentItemException,
                                                                              WafStaleDataException,
                                                                              WafLimitsExceededException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              WafException

        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.

        Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:

        • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

        • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

        • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

          You can only specify a single type of TextTransformation.

        You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

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

        1. Submit a CreateSqlInjectionMatchSet request.

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

        3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.

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

        Parameters:
        updateSqlInjectionMatchSetRequest - A request to update a SqlInjectionMatchSet.
        Returns:
        Result of the UpdateSqlInjectionMatchSet operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateSqlInjectionMatchSet

        default UpdateSqlInjectionMatchSetResponse updateSqlInjectionMatchSet​(Consumer<UpdateSqlInjectionMatchSetRequest.Builder> updateSqlInjectionMatchSetRequest)
                                                                       throws WafInternalErrorException,
                                                                              WafInvalidAccountException,
                                                                              WafInvalidOperationException,
                                                                              WafInvalidParameterException,
                                                                              WafNonexistentContainerException,
                                                                              WafNonexistentItemException,
                                                                              WafStaleDataException,
                                                                              WafLimitsExceededException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              WafException

        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.

        Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:

        • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

        • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

        • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

          You can only specify a single type of TextTransformation.

        You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

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

        1. Submit a CreateSqlInjectionMatchSet request.

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

        3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.

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


        This is a convenience which creates an instance of the UpdateSqlInjectionMatchSetRequest.Builder avoiding the need to create one manually via UpdateSqlInjectionMatchSetRequest.builder()

        Parameters:
        updateSqlInjectionMatchSetRequest - A Consumer that will call methods on UpdateSqlInjectionMatchSetRequest.Builder to create a request. A request to update a SqlInjectionMatchSet.
        Returns:
        Result of the UpdateSqlInjectionMatchSet operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateWebACL

        default UpdateWebAclResponse updateWebACL​(UpdateWebAclRequest updateWebAclRequest)
                                           throws WafStaleDataException,
                                                  WafInternalErrorException,
                                                  WafInvalidAccountException,
                                                  WafInvalidOperationException,
                                                  WafInvalidParameterException,
                                                  WafNonexistentContainerException,
                                                  WafNonexistentItemException,
                                                  WafReferencedItemException,
                                                  WafLimitsExceededException,
                                                  WafSubscriptionNotFoundException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  WafException

        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.

        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:

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

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

        3. Create a WebACL. See CreateWebACL.

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

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

        Parameters:
        updateWebAclRequest -
        Returns:
        Result of the UpdateWebACL operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafSubscriptionNotFoundException - The specified subscription does not exist.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateWebACL

        default UpdateWebAclResponse updateWebACL​(Consumer<UpdateWebAclRequest.Builder> updateWebAclRequest)
                                           throws WafStaleDataException,
                                                  WafInternalErrorException,
                                                  WafInvalidAccountException,
                                                  WafInvalidOperationException,
                                                  WafInvalidParameterException,
                                                  WafNonexistentContainerException,
                                                  WafNonexistentItemException,
                                                  WafReferencedItemException,
                                                  WafLimitsExceededException,
                                                  WafSubscriptionNotFoundException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  WafException

        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.

        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:

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

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

        3. Create a WebACL. See CreateWebACL.

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

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


        This is a convenience which creates an instance of the UpdateWebAclRequest.Builder avoiding the need to create one manually via UpdateWebAclRequest.builder()

        Parameters:
        updateWebAclRequest - A Consumer that will call methods on UpdateWebAclRequest.Builder to create a request.
        Returns:
        Result of the UpdateWebACL operation returned by the service.
        Throws:
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:

        • You tried to delete a ByteMatchSet that is still referenced by a Rule.

        • You tried to delete a Rule that is still referenced by a WebACL.

        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        WafSubscriptionNotFoundException - The specified subscription does not exist.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateXssMatchSet

        default UpdateXssMatchSetResponse updateXssMatchSet​(UpdateXssMatchSetRequest updateXssMatchSetRequest)
                                                     throws WafInternalErrorException,
                                                            WafInvalidAccountException,
                                                            WafInvalidOperationException,
                                                            WafInvalidParameterException,
                                                            WafNonexistentContainerException,
                                                            WafNonexistentItemException,
                                                            WafStaleDataException,
                                                            WafLimitsExceededException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            WafException

        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.

        Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:

        • Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one.

        • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

        • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.

          You can only specify a single type of TextTransformation.

        You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

        To create and configure an XssMatchSet, perform the following steps:

        1. Submit a CreateXssMatchSet request.

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

        3. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.

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

        Parameters:
        updateXssMatchSetRequest - A request to update an XssMatchSet.
        Returns:
        Result of the UpdateXssMatchSet operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • updateXssMatchSet

        default UpdateXssMatchSetResponse updateXssMatchSet​(Consumer<UpdateXssMatchSetRequest.Builder> updateXssMatchSetRequest)
                                                     throws WafInternalErrorException,
                                                            WafInvalidAccountException,
                                                            WafInvalidOperationException,
                                                            WafInvalidParameterException,
                                                            WafNonexistentContainerException,
                                                            WafNonexistentItemException,
                                                            WafStaleDataException,
                                                            WafLimitsExceededException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            WafException

        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.

        Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:

        • Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one.

        • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

        • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.

          You can only specify a single type of TextTransformation.

        You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

        To create and configure an XssMatchSet, perform the following steps:

        1. Submit a CreateXssMatchSet request.

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

        3. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.

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


        This is a convenience which creates an instance of the UpdateXssMatchSetRequest.Builder avoiding the need to create one manually via UpdateXssMatchSetRequest.builder()

        Parameters:
        updateXssMatchSetRequest - A Consumer that will call methods on UpdateXssMatchSetRequest.Builder to create a request. A request to update an XssMatchSet.
        Returns:
        Result of the UpdateXssMatchSet operation returned by the service.
        Throws:
        WafInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.
        WafInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
        WafInvalidOperationException - The operation failed because there was nothing to do. For example:

        • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

        • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

        • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

        • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

        • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

        WafInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

        • You specified an invalid parameter name.

        • You specified an invalid value.

        • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

        • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to create a RateBasedRule with a RateKey value other than IP.

        • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

        • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

        • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

        WafNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

        • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

        • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

        • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

        • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

        WafNonexistentItemException - The operation failed because the referenced object doesn't exist.
        WafStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
        WafLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        WafException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation