Interface Wafv2AsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface Wafv2AsyncClient extends AwsClient
Service client for accessing WAFV2 asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. WAF

This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.

If you used WAF prior to this release, you can't use this WAFV2 API to access any WAF resources that you created before. You can access your old rules, web ACLs, and other WAF resources only through the WAF Classic APIs. The WAF Classic APIs have retained the prior names, endpoints, and namespaces.

For information, including how to migrate your WAF resources to this version, see the WAF Developer Guide.

WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, or Amazon Web Services Verified Access instance. WAF also lets you control access to your content, to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code (Forbidden), or with a custom response.

This API guide is for developers who need detailed information about WAF API actions, data types, and errors. For detailed information about WAF features and guidance for configuring and using WAF, see the WAF Developer Guide.

You can make calls using the endpoints listed in WAF endpoints and quotas.

  • For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

  • For Amazon CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

We currently provide two versions of the WAF API: this API and the prior versions, the classic WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:

  • You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a Scope parameter and set it to CLOUDFRONT or REGIONAL.

  • You can define a web ACL or rule group with a single call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or web ACL calls.

  • The limits WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.

  • Field Details

  • Method Details

    • associateWebACL

      default CompletableFuture<AssociateWebAclResponse> associateWebACL(AssociateWebAclRequest associateWebAclRequest)

      Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

      For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide.

      Required permissions for customer-managed IAM policies

      This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the WAF Developer Guide.

      Temporary inconsistencies during updates

      When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

      The following are examples of the temporary inconsistencies that you might notice during change propagation:

      • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

      • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

      • After you change a rule action setting, you might see the old action in some places and the new action in others.

      • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

      Parameters:
      associateWebAclRequest -
      Returns:
      A Java Future containing the result of the AssociateWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateWebACL

      default CompletableFuture<AssociateWebAclResponse> associateWebACL(Consumer<AssociateWebAclRequest.Builder> associateWebAclRequest)

      Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

      For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide.

      Required permissions for customer-managed IAM policies

      This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the WAF Developer Guide.

      Temporary inconsistencies during updates

      When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

      The following are examples of the temporary inconsistencies that you might notice during change propagation:

      • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

      • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

      • After you change a rule action setting, you might see the old action in some places and the new action in others.

      • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.


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

      Parameters:
      associateWebAclRequest - A Consumer that will call methods on AssociateWebAclRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • checkCapacity

      default CompletableFuture<CheckCapacityResponse> checkCapacity(CheckCapacityRequest checkCapacityRequest)

      Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.

      WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

      Parameters:
      checkCapacityRequest -
      Returns:
      A Java Future containing the result of the CheckCapacity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafInvalidResourceException WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
        • WafExpiredManagedRuleGroupVersionException The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • checkCapacity

      default CompletableFuture<CheckCapacityResponse> checkCapacity(Consumer<CheckCapacityRequest.Builder> checkCapacityRequest)

      Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.

      WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.


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

      Parameters:
      checkCapacityRequest - A Consumer that will call methods on CheckCapacityRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CheckCapacity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafInvalidResourceException WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
        • WafExpiredManagedRuleGroupVersionException The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAPIKey

      default CompletableFuture<CreateApiKeyResponse> createAPIKey(CreateApiKeyRequest createApiKeyRequest)

      Creates an API key that contains a set of token domains.

      API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

      You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.

      Parameters:
      createApiKeyRequest -
      Returns:
      A Java Future containing the result of the CreateAPIKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAPIKey

      default CompletableFuture<CreateApiKeyResponse> createAPIKey(Consumer<CreateApiKeyRequest.Builder> createApiKeyRequest)

      Creates an API key that contains a set of token domains.

      API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

      You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.


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

      Parameters:
      createApiKeyRequest - A Consumer that will call methods on CreateApiKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAPIKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createIPSet

      default CompletableFuture<CreateIpSetResponse> createIPSet(CreateIpSetRequest createIpSetRequest)

      Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.

      Parameters:
      createIpSetRequest -
      Returns:
      A Java Future containing the result of the CreateIPSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createIPSet

      default CompletableFuture<CreateIpSetResponse> createIPSet(Consumer<CreateIpSetRequest.Builder> createIpSetRequest)

      Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.


      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:
      A Java Future containing the result of the CreateIPSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRegexPatternSet

      default CompletableFuture<CreateRegexPatternSetResponse> createRegexPatternSet(CreateRegexPatternSetRequest createRegexPatternSetRequest)

      Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.

      Parameters:
      createRegexPatternSetRequest -
      Returns:
      A Java Future containing the result of the CreateRegexPatternSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRegexPatternSet

      default CompletableFuture<CreateRegexPatternSetResponse> createRegexPatternSet(Consumer<CreateRegexPatternSetRequest.Builder> createRegexPatternSetRequest)

      Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.


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

      Parameters:
      createRegexPatternSetRequest - A Consumer that will call methods on CreateRegexPatternSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRegexPatternSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRuleGroup

      default CompletableFuture<CreateRuleGroupResponse> createRuleGroup(CreateRuleGroupRequest createRuleGroupRequest)

      Creates a RuleGroup per the specifications provided.

      A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

      Parameters:
      createRuleGroupRequest -
      Returns:
      A Java Future containing the result of the CreateRuleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRuleGroup

      default CompletableFuture<CreateRuleGroupResponse> createRuleGroup(Consumer<CreateRuleGroupRequest.Builder> createRuleGroupRequest)

      Creates a RuleGroup per the specifications provided.

      A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.


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

      Parameters:
      createRuleGroupRequest - A Consumer that will call methods on CreateRuleGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRuleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWebACL

      default CompletableFuture<CreateWebAclResponse> createWebACL(CreateWebAclRequest createWebAclRequest)

      Creates a WebACL per the specifications provided.

      A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

      Parameters:
      createWebAclRequest -
      Returns:
      A Java Future containing the result of the CreateWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafInvalidResourceException WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
        • WafInvalidOperationException The operation isn't valid.
        • WafConfigurationWarningException The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration.

          Provide the handling configuration and retry your operation.

          Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value: true).

        • WafExpiredManagedRuleGroupVersionException The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWebACL

      default CompletableFuture<CreateWebAclResponse> createWebACL(Consumer<CreateWebAclRequest.Builder> createWebAclRequest)

      Creates a WebACL per the specifications provided.

      A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.


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

      Parameters:
      createWebAclRequest - A Consumer that will call methods on CreateWebAclRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafInvalidResourceException WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
        • WafInvalidOperationException The operation isn't valid.
        • WafConfigurationWarningException The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration.

          Provide the handling configuration and retry your operation.

          Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value: true).

        • WafExpiredManagedRuleGroupVersionException The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAPIKey

      default CompletableFuture<DeleteApiKeyResponse> deleteAPIKey(DeleteApiKeyRequest deleteApiKeyRequest)

      Deletes the specified API key.

      After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.

      Parameters:
      deleteApiKeyRequest -
      Returns:
      A Java Future containing the result of the DeleteAPIKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAPIKey

      default CompletableFuture<DeleteApiKeyResponse> deleteAPIKey(Consumer<DeleteApiKeyRequest.Builder> deleteApiKeyRequest)

      Deletes the specified API key.

      After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.


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

      Parameters:
      deleteApiKeyRequest - A Consumer that will call methods on DeleteApiKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAPIKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFirewallManagerRuleGroups

      default CompletableFuture<DeleteFirewallManagerRuleGroupsResponse> deleteFirewallManagerRuleGroups(DeleteFirewallManagerRuleGroupsRequest deleteFirewallManagerRuleGroupsRequest)

      Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

      You can only use this if ManagedByFirewallManager is false in the specified WebACL.

      Parameters:
      deleteFirewallManagerRuleGroupsRequest -
      Returns:
      A Java Future containing the result of the DeleteFirewallManagerRuleGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFirewallManagerRuleGroups

      default CompletableFuture<DeleteFirewallManagerRuleGroupsResponse> deleteFirewallManagerRuleGroups(Consumer<DeleteFirewallManagerRuleGroupsRequest.Builder> deleteFirewallManagerRuleGroupsRequest)

      Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

      You can only use this if ManagedByFirewallManager is false in the specified WebACL.


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

      Parameters:
      deleteFirewallManagerRuleGroupsRequest - A Consumer that will call methods on DeleteFirewallManagerRuleGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFirewallManagerRuleGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIPSet

      default CompletableFuture<DeleteIpSetResponse> deleteIPSet(DeleteIpSetRequest deleteIpSetRequest)

      Deletes the specified IPSet.

      Parameters:
      deleteIpSetRequest -
      Returns:
      A Java Future containing the result of the DeleteIPSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafAssociatedItemException WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIPSet

      default CompletableFuture<DeleteIpSetResponse> deleteIPSet(Consumer<DeleteIpSetRequest.Builder> deleteIpSetRequest)

      Deletes the specified IPSet.


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

      Parameters:
      deleteIpSetRequest - A Consumer that will call methods on DeleteIpSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteIPSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafAssociatedItemException WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLoggingConfiguration

      default CompletableFuture<DeleteLoggingConfigurationResponse> deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest)

      Deletes the LoggingConfiguration from the specified web ACL.

      Parameters:
      deleteLoggingConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLoggingConfiguration

      default CompletableFuture<DeleteLoggingConfigurationResponse> deleteLoggingConfiguration(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest)

      Deletes the LoggingConfiguration from the specified web ACL.


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

      Parameters:
      deleteLoggingConfigurationRequest - A Consumer that will call methods on DeleteLoggingConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePermissionPolicy

      default CompletableFuture<DeletePermissionPolicyResponse> deletePermissionPolicy(DeletePermissionPolicyRequest deletePermissionPolicyRequest)

      Permanently deletes an IAM policy from the specified rule group.

      You must be the owner of the rule group to perform this operation.

      Parameters:
      deletePermissionPolicyRequest -
      Returns:
      A Java Future containing the result of the DeletePermissionPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePermissionPolicy

      default CompletableFuture<DeletePermissionPolicyResponse> deletePermissionPolicy(Consumer<DeletePermissionPolicyRequest.Builder> deletePermissionPolicyRequest)

      Permanently deletes an IAM policy from the specified rule group.

      You must be the owner of the rule group to perform this operation.


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

      Parameters:
      deletePermissionPolicyRequest - A Consumer that will call methods on DeletePermissionPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePermissionPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRegexPatternSet

      default CompletableFuture<DeleteRegexPatternSetResponse> deleteRegexPatternSet(DeleteRegexPatternSetRequest deleteRegexPatternSetRequest)

      Deletes the specified RegexPatternSet.

      Parameters:
      deleteRegexPatternSetRequest -
      Returns:
      A Java Future containing the result of the DeleteRegexPatternSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafAssociatedItemException WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRegexPatternSet

      default CompletableFuture<DeleteRegexPatternSetResponse> deleteRegexPatternSet(Consumer<DeleteRegexPatternSetRequest.Builder> deleteRegexPatternSetRequest)

      Deletes the specified RegexPatternSet.


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

      Parameters:
      deleteRegexPatternSetRequest - A Consumer that will call methods on DeleteRegexPatternSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRegexPatternSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafAssociatedItemException WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRuleGroup

      default CompletableFuture<DeleteRuleGroupResponse> deleteRuleGroup(DeleteRuleGroupRequest deleteRuleGroupRequest)

      Deletes the specified RuleGroup.

      Parameters:
      deleteRuleGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteRuleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafAssociatedItemException WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRuleGroup

      default CompletableFuture<DeleteRuleGroupResponse> deleteRuleGroup(Consumer<DeleteRuleGroupRequest.Builder> deleteRuleGroupRequest)

      Deletes the specified RuleGroup.


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

      Parameters:
      deleteRuleGroupRequest - A Consumer that will call methods on DeleteRuleGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRuleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafAssociatedItemException WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWebACL

      default CompletableFuture<DeleteWebAclResponse> deleteWebACL(DeleteWebAclRequest deleteWebAclRequest)

      Deletes the specified WebACL.

      You can only use this if ManagedByFirewallManager is false in the specified WebACL.

      Before deleting any web ACL, first disassociate it from all resources.

      • To retrieve a list of the resources that are associated with a web ACL, use the following calls:

      • To disassociate a resource from a web ACL, use the following calls:

        • For regional resources, call DisassociateWebACL.

        • For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

      Parameters:
      deleteWebAclRequest -
      Returns:
      A Java Future containing the result of the DeleteWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafAssociatedItemException WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWebACL

      default CompletableFuture<DeleteWebAclResponse> deleteWebACL(Consumer<DeleteWebAclRequest.Builder> deleteWebAclRequest)

      Deletes the specified WebACL.

      You can only use this if ManagedByFirewallManager is false in the specified WebACL.

      Before deleting any web ACL, first disassociate it from all resources.

      • To retrieve a list of the resources that are associated with a web ACL, use the following calls:

      • To disassociate a resource from a web ACL, use the following calls:

        • For regional resources, call DisassociateWebACL.

        • For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.


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

      Parameters:
      deleteWebAclRequest - A Consumer that will call methods on DeleteWebAclRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafAssociatedItemException WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAllManagedProducts

      default CompletableFuture<DescribeAllManagedProductsResponse> describeAllManagedProducts(DescribeAllManagedProductsRequest describeAllManagedProductsRequest)

      Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

      Parameters:
      describeAllManagedProductsRequest -
      Returns:
      A Java Future containing the result of the DescribeAllManagedProducts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInvalidOperationException The operation isn't valid.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAllManagedProducts

      default CompletableFuture<DescribeAllManagedProductsResponse> describeAllManagedProducts(Consumer<DescribeAllManagedProductsRequest.Builder> describeAllManagedProductsRequest)

      Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.


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

      Parameters:
      describeAllManagedProductsRequest - A Consumer that will call methods on DescribeAllManagedProductsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAllManagedProducts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInvalidOperationException The operation isn't valid.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeManagedProductsByVendor

      default CompletableFuture<DescribeManagedProductsByVendorResponse> describeManagedProductsByVendor(DescribeManagedProductsByVendorRequest describeManagedProductsByVendorRequest)

      Provides high-level information for the managed rule groups owned by a specific vendor.

      Parameters:
      describeManagedProductsByVendorRequest -
      Returns:
      A Java Future containing the result of the DescribeManagedProductsByVendor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInvalidOperationException The operation isn't valid.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeManagedProductsByVendor

      default CompletableFuture<DescribeManagedProductsByVendorResponse> describeManagedProductsByVendor(Consumer<DescribeManagedProductsByVendorRequest.Builder> describeManagedProductsByVendorRequest)

      Provides high-level information for the managed rule groups owned by a specific vendor.


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

      Parameters:
      describeManagedProductsByVendorRequest - A Consumer that will call methods on DescribeManagedProductsByVendorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeManagedProductsByVendor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInvalidOperationException The operation isn't valid.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeManagedRuleGroup

      default CompletableFuture<DescribeManagedRuleGroupResponse> describeManagedRuleGroup(DescribeManagedRuleGroupRequest describeManagedRuleGroupRequest)

      Provides high-level information for a managed rule group, including descriptions of the rules.

      Parameters:
      describeManagedRuleGroupRequest -
      Returns:
      A Java Future containing the result of the DescribeManagedRuleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidResourceException WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • WafExpiredManagedRuleGroupVersionException The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeManagedRuleGroup

      default CompletableFuture<DescribeManagedRuleGroupResponse> describeManagedRuleGroup(Consumer<DescribeManagedRuleGroupRequest.Builder> describeManagedRuleGroupRequest)

      Provides high-level information for a managed rule group, including descriptions of the rules.


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

      Parameters:
      describeManagedRuleGroupRequest - A Consumer that will call methods on DescribeManagedRuleGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeManagedRuleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidResourceException WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • WafExpiredManagedRuleGroupVersionException The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateWebACL

      default CompletableFuture<DisassociateWebAclResponse> disassociateWebACL(DisassociateWebAclRequest disassociateWebAclRequest)

      Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

      For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

      Required permissions for customer-managed IAM policies

      This call requires permissions that are specific to the protected resource type. For details, see Permissions for DisassociateWebACL in the WAF Developer Guide.

      Parameters:
      disassociateWebAclRequest -
      Returns:
      A Java Future containing the result of the DisassociateWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateWebACL

      default CompletableFuture<DisassociateWebAclResponse> disassociateWebACL(Consumer<DisassociateWebAclRequest.Builder> disassociateWebAclRequest)

      Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

      For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

      Required permissions for customer-managed IAM policies

      This call requires permissions that are specific to the protected resource type. For details, see Permissions for DisassociateWebACL in the WAF Developer Guide.


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

      Parameters:
      disassociateWebAclRequest - A Consumer that will call methods on DisassociateWebAclRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • generateMobileSdkReleaseUrl

      default CompletableFuture<GenerateMobileSdkReleaseUrlResponse> generateMobileSdkReleaseUrl(GenerateMobileSdkReleaseUrlRequest generateMobileSdkReleaseUrlRequest)

      Generates a presigned download URL for the specified release of the mobile SDK.

      The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

      Parameters:
      generateMobileSdkReleaseUrlRequest -
      Returns:
      A Java Future containing the result of the GenerateMobileSdkReleaseUrl operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • generateMobileSdkReleaseUrl

      default CompletableFuture<GenerateMobileSdkReleaseUrlResponse> generateMobileSdkReleaseUrl(Consumer<GenerateMobileSdkReleaseUrlRequest.Builder> generateMobileSdkReleaseUrlRequest)

      Generates a presigned download URL for the specified release of the mobile SDK.

      The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.


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

      Parameters:
      generateMobileSdkReleaseUrlRequest - A Consumer that will call methods on GenerateMobileSdkReleaseUrlRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GenerateMobileSdkReleaseUrl operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDecryptedAPIKey

      default CompletableFuture<GetDecryptedApiKeyResponse> getDecryptedAPIKey(GetDecryptedApiKeyRequest getDecryptedApiKeyRequest)

      Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.

      API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

      Parameters:
      getDecryptedApiKeyRequest -
      Returns:
      A Java Future containing the result of the GetDecryptedAPIKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • WafInvalidResourceException WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDecryptedAPIKey

      default CompletableFuture<GetDecryptedApiKeyResponse> getDecryptedAPIKey(Consumer<GetDecryptedApiKeyRequest.Builder> getDecryptedApiKeyRequest)

      Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.

      API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.


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

      Parameters:
      getDecryptedApiKeyRequest - A Consumer that will call methods on GetDecryptedApiKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDecryptedAPIKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • WafInvalidResourceException WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getIPSet

      default CompletableFuture<GetIpSetResponse> getIPSet(GetIpSetRequest getIpSetRequest)

      Retrieves the specified IPSet.

      Parameters:
      getIpSetRequest -
      Returns:
      A Java Future containing the result of the GetIPSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getIPSet

      default CompletableFuture<GetIpSetResponse> getIPSet(Consumer<GetIpSetRequest.Builder> getIpSetRequest)

      Retrieves the specified IPSet.


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

      Parameters:
      getIpSetRequest - A Consumer that will call methods on GetIpSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetIPSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoggingConfiguration

      default CompletableFuture<GetLoggingConfigurationResponse> getLoggingConfiguration(GetLoggingConfigurationRequest getLoggingConfigurationRequest)

      Returns the LoggingConfiguration for the specified web ACL.

      Parameters:
      getLoggingConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoggingConfiguration

      default CompletableFuture<GetLoggingConfigurationResponse> getLoggingConfiguration(Consumer<GetLoggingConfigurationRequest.Builder> getLoggingConfigurationRequest)

      Returns the LoggingConfiguration for the specified web ACL.


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

      Parameters:
      getLoggingConfigurationRequest - A Consumer that will call methods on GetLoggingConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getManagedRuleSet

      default CompletableFuture<GetManagedRuleSetResponse> getManagedRuleSet(GetManagedRuleSetRequest getManagedRuleSetRequest)

      Retrieves the specified managed rule set.

      This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

      Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

      Parameters:
      getManagedRuleSetRequest -
      Returns:
      A Java Future containing the result of the GetManagedRuleSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getManagedRuleSet

      default CompletableFuture<GetManagedRuleSetResponse> getManagedRuleSet(Consumer<GetManagedRuleSetRequest.Builder> getManagedRuleSetRequest)

      Retrieves the specified managed rule set.

      This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

      Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.


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

      Parameters:
      getManagedRuleSetRequest - A Consumer that will call methods on GetManagedRuleSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetManagedRuleSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMobileSdkRelease

      default CompletableFuture<GetMobileSdkReleaseResponse> getMobileSdkRelease(GetMobileSdkReleaseRequest getMobileSdkReleaseRequest)

      Retrieves information for the specified mobile SDK release, including release notes and tags.

      The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

      Parameters:
      getMobileSdkReleaseRequest -
      Returns:
      A Java Future containing the result of the GetMobileSdkRelease operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMobileSdkRelease

      default CompletableFuture<GetMobileSdkReleaseResponse> getMobileSdkRelease(Consumer<GetMobileSdkReleaseRequest.Builder> getMobileSdkReleaseRequest)

      Retrieves information for the specified mobile SDK release, including release notes and tags.

      The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.


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

      Parameters:
      getMobileSdkReleaseRequest - A Consumer that will call methods on GetMobileSdkReleaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMobileSdkRelease operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPermissionPolicy

      default CompletableFuture<GetPermissionPolicyResponse> getPermissionPolicy(GetPermissionPolicyRequest getPermissionPolicyRequest)

      Returns the IAM policy that is attached to the specified rule group.

      You must be the owner of the rule group to perform this operation.

      Parameters:
      getPermissionPolicyRequest -
      Returns:
      A Java Future containing the result of the GetPermissionPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPermissionPolicy

      default CompletableFuture<GetPermissionPolicyResponse> getPermissionPolicy(Consumer<GetPermissionPolicyRequest.Builder> getPermissionPolicyRequest)

      Returns the IAM policy that is attached to the specified rule group.

      You must be the owner of the rule group to perform this operation.


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

      Parameters:
      getPermissionPolicyRequest - A Consumer that will call methods on GetPermissionPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPermissionPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRateBasedStatementManagedKeys

      default CompletableFuture<GetRateBasedStatementManagedKeysResponse> getRateBasedStatementManagedKeys(GetRateBasedStatementManagedKeysRequest getRateBasedStatementManagedKeysRequest)

      Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address.

      The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.

      For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.

      WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.

      Parameters:
      getRateBasedStatementManagedKeysRequest -
      Returns:
      A Java Future containing the result of the GetRateBasedStatementManagedKeys operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • WafUnsupportedAggregateKeyTypeException The rule that you've named doesn't aggregate solely on the IP address or solely on the forwarded IP address. This call is only available for rate-based rules with an AggregateKeyType setting of IP or FORWARDED_IP.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRateBasedStatementManagedKeys

      default CompletableFuture<GetRateBasedStatementManagedKeysResponse> getRateBasedStatementManagedKeys(Consumer<GetRateBasedStatementManagedKeysRequest.Builder> getRateBasedStatementManagedKeysRequest)

      Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address.

      The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.

      For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.

      WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.


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

      Parameters:
      getRateBasedStatementManagedKeysRequest - A Consumer that will call methods on GetRateBasedStatementManagedKeysRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRateBasedStatementManagedKeys operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • WafUnsupportedAggregateKeyTypeException The rule that you've named doesn't aggregate solely on the IP address or solely on the forwarded IP address. This call is only available for rate-based rules with an AggregateKeyType setting of IP or FORWARDED_IP.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRegexPatternSet

      default CompletableFuture<GetRegexPatternSetResponse> getRegexPatternSet(GetRegexPatternSetRequest getRegexPatternSetRequest)

      Retrieves the specified RegexPatternSet.

      Parameters:
      getRegexPatternSetRequest -
      Returns:
      A Java Future containing the result of the GetRegexPatternSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRegexPatternSet

      default CompletableFuture<GetRegexPatternSetResponse> getRegexPatternSet(Consumer<GetRegexPatternSetRequest.Builder> getRegexPatternSetRequest)

      Retrieves the specified RegexPatternSet.


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

      Parameters:
      getRegexPatternSetRequest - A Consumer that will call methods on GetRegexPatternSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRegexPatternSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRuleGroup

      default CompletableFuture<GetRuleGroupResponse> getRuleGroup(GetRuleGroupRequest getRuleGroupRequest)

      Retrieves the specified RuleGroup.

      Parameters:
      getRuleGroupRequest -
      Returns:
      A Java Future containing the result of the GetRuleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRuleGroup

      default CompletableFuture<GetRuleGroupResponse> getRuleGroup(Consumer<GetRuleGroupRequest.Builder> getRuleGroupRequest)

      Retrieves the specified RuleGroup.


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

      Parameters:
      getRuleGroupRequest - A Consumer that will call methods on GetRuleGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRuleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSampledRequests

      default CompletableFuture<GetSampledRequestsResponse> getSampledRequests(GetSampledRequestsRequest getSampledRequestsRequest)

      Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services 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 WAF selected the requests in the sample.

      Parameters:
      getSampledRequestsRequest -
      Returns:
      A Java Future containing the result of the GetSampledRequests operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSampledRequests

      default CompletableFuture<GetSampledRequestsResponse> getSampledRequests(Consumer<GetSampledRequestsRequest.Builder> getSampledRequestsRequest)

      Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services 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 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:
      A Java Future containing the result of the GetSampledRequests operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

        • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWebACL

      default CompletableFuture<GetWebAclResponse> getWebACL(GetWebAclRequest getWebAclRequest)

      Retrieves the specified WebACL.

      Parameters:
      getWebAclRequest -
      Returns:
      A Java Future containing the result of the GetWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWebACL

      default CompletableFuture<GetWebAclResponse> getWebACL(Consumer<GetWebAclRequest.Builder> getWebAclRequest)

      Retrieves the specified WebACL.


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

      Parameters:
      getWebAclRequest - A Consumer that will call methods on GetWebAclRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWebACLForResource

      default CompletableFuture<GetWebAclForResourceResponse> getWebACLForResource(GetWebAclForResourceRequest getWebAclForResourceRequest)

      Retrieves the WebACL for the specified resource.

      This call uses GetWebACL, to verify that your account has permission to access the retrieved web ACL. If you get an error that indicates that your account isn't authorized to perform wafv2:GetWebACL on the resource, that error won't be included in your CloudTrail event history.

      For Amazon CloudFront, don't use this call. Instead, call the CloudFront action GetDistributionConfig. For information, see GetDistributionConfig in the Amazon CloudFront API Reference.

      Required permissions for customer-managed IAM policies

      This call requires permissions that are specific to the protected resource type. For details, see Permissions for GetWebACLForResource in the WAF Developer Guide.

      Parameters:
      getWebAclForResourceRequest -
      Returns:
      A Java Future containing the result of the GetWebACLForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWebACLForResource

      default CompletableFuture<GetWebAclForResourceResponse> getWebACLForResource(Consumer<GetWebAclForResourceRequest.Builder> getWebAclForResourceRequest)

      Retrieves the WebACL for the specified resource.

      This call uses GetWebACL, to verify that your account has permission to access the retrieved web ACL. If you get an error that indicates that your account isn't authorized to perform wafv2:GetWebACL on the resource, that error won't be included in your CloudTrail event history.

      For Amazon CloudFront, don't use this call. Instead, call the CloudFront action GetDistributionConfig. For information, see GetDistributionConfig in the Amazon CloudFront API Reference.

      Required permissions for customer-managed IAM policies

      This call requires permissions that are specific to the protected resource type. For details, see Permissions for GetWebACLForResource in the WAF Developer Guide.


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

      Parameters:
      getWebAclForResourceRequest - A Consumer that will call methods on GetWebAclForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetWebACLForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAPIKeys

      default CompletableFuture<ListApiKeysResponse> listAPIKeys(ListApiKeysRequest listApiKeysRequest)

      Retrieves a list of the API keys that you've defined for the specified scope.

      API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

      Parameters:
      listApiKeysRequest -
      Returns:
      A Java Future containing the result of the ListAPIKeys operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • WafInvalidResourceException WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAPIKeys

      default CompletableFuture<ListApiKeysResponse> listAPIKeys(Consumer<ListApiKeysRequest.Builder> listApiKeysRequest)

      Retrieves a list of the API keys that you've defined for the specified scope.

      API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.


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

      Parameters:
      listApiKeysRequest - A Consumer that will call methods on ListApiKeysRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAPIKeys operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • WafInvalidResourceException WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableManagedRuleGroupVersions

      default CompletableFuture<ListAvailableManagedRuleGroupVersionsResponse> listAvailableManagedRuleGroupVersions(ListAvailableManagedRuleGroupVersionsRequest listAvailableManagedRuleGroupVersionsRequest)

      Returns a list of the available versions for the specified managed rule group.

      Parameters:
      listAvailableManagedRuleGroupVersionsRequest -
      Returns:
      A Java Future containing the result of the ListAvailableManagedRuleGroupVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableManagedRuleGroupVersions

      default CompletableFuture<ListAvailableManagedRuleGroupVersionsResponse> listAvailableManagedRuleGroupVersions(Consumer<ListAvailableManagedRuleGroupVersionsRequest.Builder> listAvailableManagedRuleGroupVersionsRequest)

      Returns a list of the available versions for the specified managed rule group.


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

      Parameters:
      listAvailableManagedRuleGroupVersionsRequest - A Consumer that will call methods on ListAvailableManagedRuleGroupVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAvailableManagedRuleGroupVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableManagedRuleGroups

      default CompletableFuture<ListAvailableManagedRuleGroupsResponse> listAvailableManagedRuleGroups(ListAvailableManagedRuleGroupsRequest listAvailableManagedRuleGroupsRequest)

      Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.

      Parameters:
      listAvailableManagedRuleGroupsRequest -
      Returns:
      A Java Future containing the result of the ListAvailableManagedRuleGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableManagedRuleGroups

      default CompletableFuture<ListAvailableManagedRuleGroupsResponse> listAvailableManagedRuleGroups(Consumer<ListAvailableManagedRuleGroupsRequest.Builder> listAvailableManagedRuleGroupsRequest)

      Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.


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

      Parameters:
      listAvailableManagedRuleGroupsRequest - A Consumer that will call methods on ListAvailableManagedRuleGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAvailableManagedRuleGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIPSets

      default CompletableFuture<ListIpSetsResponse> listIPSets(ListIpSetsRequest listIpSetsRequest)

      Retrieves an array of IPSetSummary objects for the IP sets that you manage.

      Parameters:
      listIpSetsRequest -
      Returns:
      A Java Future containing the result of the ListIPSets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIPSets

      default CompletableFuture<ListIpSetsResponse> listIPSets(Consumer<ListIpSetsRequest.Builder> listIpSetsRequest)

      Retrieves an array of IPSetSummary objects for the IP sets that you manage.


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

      Parameters:
      listIpSetsRequest - A Consumer that will call methods on ListIpSetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListIPSets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLoggingConfigurations

      default CompletableFuture<ListLoggingConfigurationsResponse> listLoggingConfigurations(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest)

      Retrieves an array of your LoggingConfiguration objects.

      Parameters:
      listLoggingConfigurationsRequest -
      Returns:
      A Java Future containing the result of the ListLoggingConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLoggingConfigurations

      default CompletableFuture<ListLoggingConfigurationsResponse> listLoggingConfigurations(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest)

      Retrieves an array of your LoggingConfiguration objects.


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

      Parameters:
      listLoggingConfigurationsRequest - A Consumer that will call methods on ListLoggingConfigurationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLoggingConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listManagedRuleSets

      default CompletableFuture<ListManagedRuleSetsResponse> listManagedRuleSets(ListManagedRuleSetsRequest listManagedRuleSetsRequest)

      Retrieves the managed rule sets that you own.

      This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

      Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

      Parameters:
      listManagedRuleSetsRequest -
      Returns:
      A Java Future containing the result of the ListManagedRuleSets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listManagedRuleSets

      default CompletableFuture<ListManagedRuleSetsResponse> listManagedRuleSets(Consumer<ListManagedRuleSetsRequest.Builder> listManagedRuleSetsRequest)

      Retrieves the managed rule sets that you own.

      This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

      Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.


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

      Parameters:
      listManagedRuleSetsRequest - A Consumer that will call methods on ListManagedRuleSetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListManagedRuleSets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMobileSdkReleases

      default CompletableFuture<ListMobileSdkReleasesResponse> listMobileSdkReleases(ListMobileSdkReleasesRequest listMobileSdkReleasesRequest)

      Retrieves a list of the available releases for the mobile SDK and the specified device platform.

      The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.

      Parameters:
      listMobileSdkReleasesRequest -
      Returns:
      A Java Future containing the result of the ListMobileSdkReleases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMobileSdkReleases

      default CompletableFuture<ListMobileSdkReleasesResponse> listMobileSdkReleases(Consumer<ListMobileSdkReleasesRequest.Builder> listMobileSdkReleasesRequest)

      Retrieves a list of the available releases for the mobile SDK and the specified device platform.

      The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.


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

      Parameters:
      listMobileSdkReleasesRequest - A Consumer that will call methods on ListMobileSdkReleasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMobileSdkReleases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegexPatternSets

      default CompletableFuture<ListRegexPatternSetsResponse> listRegexPatternSets(ListRegexPatternSetsRequest listRegexPatternSetsRequest)

      Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.

      Parameters:
      listRegexPatternSetsRequest -
      Returns:
      A Java Future containing the result of the ListRegexPatternSets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegexPatternSets

      default CompletableFuture<ListRegexPatternSetsResponse> listRegexPatternSets(Consumer<ListRegexPatternSetsRequest.Builder> listRegexPatternSetsRequest)

      Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.


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

      Parameters:
      listRegexPatternSetsRequest - A Consumer that will call methods on ListRegexPatternSetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRegexPatternSets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourcesForWebACL

      default CompletableFuture<ListResourcesForWebAclResponse> listResourcesForWebACL(ListResourcesForWebAclRequest listResourcesForWebAclRequest)

      Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.

      For Amazon CloudFront, don't use this call. Instead, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.

      Required permissions for customer-managed IAM policies

      This call requires permissions that are specific to the protected resource type. For details, see Permissions for ListResourcesForWebACL in the WAF Developer Guide.

      Parameters:
      listResourcesForWebAclRequest -
      Returns:
      A Java Future containing the result of the ListResourcesForWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourcesForWebACL

      default CompletableFuture<ListResourcesForWebAclResponse> listResourcesForWebACL(Consumer<ListResourcesForWebAclRequest.Builder> listResourcesForWebAclRequest)

      Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.

      For Amazon CloudFront, don't use this call. Instead, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.

      Required permissions for customer-managed IAM policies

      This call requires permissions that are specific to the protected resource type. For details, see Permissions for ListResourcesForWebACL in the WAF Developer Guide.


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

      Parameters:
      listResourcesForWebAclRequest - A Consumer that will call methods on ListResourcesForWebAclRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListResourcesForWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRuleGroups

      default CompletableFuture<ListRuleGroupsResponse> listRuleGroups(ListRuleGroupsRequest listRuleGroupsRequest)

      Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.

      Parameters:
      listRuleGroupsRequest -
      Returns:
      A Java Future containing the result of the ListRuleGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRuleGroups

      default CompletableFuture<ListRuleGroupsResponse> listRuleGroups(Consumer<ListRuleGroupsRequest.Builder> listRuleGroupsRequest)

      Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.


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

      Parameters:
      listRuleGroupsRequest - A Consumer that will call methods on ListRuleGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRuleGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Retrieves the TagInfoForResource for the specified 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 Amazon Web Services resource, up to 50 tags for a resource.

      You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Retrieves the TagInfoForResource for the specified 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 Amazon Web Services resource, up to 50 tags for a resource.

      You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWebACLs

      default CompletableFuture<ListWebAcLsResponse> listWebACLs(ListWebAcLsRequest listWebAcLsRequest)

      Retrieves an array of WebACLSummary objects for the web ACLs that you manage.

      Parameters:
      listWebAcLsRequest -
      Returns:
      A Java Future containing the result of the ListWebACLs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWebACLs

      default CompletableFuture<ListWebAcLsResponse> listWebACLs(Consumer<ListWebAcLsRequest.Builder> listWebAcLsRequest)

      Retrieves an array of WebACLSummary objects for the web ACLs that you manage.


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

      Parameters:
      listWebAcLsRequest - A Consumer that will call methods on ListWebAcLsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWebACLs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putLoggingConfiguration

      default CompletableFuture<PutLoggingConfigurationResponse> putLoggingConfiguration(PutLoggingConfigurationRequest putLoggingConfigurationRequest)

      Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

      This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.

      To modify an existing logging configuration, do the following:

      1. Retrieve it by calling GetLoggingConfiguration

      2. Update its settings as needed

      3. Provide the complete logging configuration specification to this call

      You can define one logging destination per web ACL.

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

      1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

        The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

        For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.

      2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request.

      When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

      For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.

      Parameters:
      putLoggingConfigurationRequest -
      Returns:
      A Java Future containing the result of the PutLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
      • WafServiceLinkedRoleErrorException 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 call to 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.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafLogDestinationPermissionIssueException The operation failed because you don't have the permissions that your logging configuration requires. For information, see Logging web ACL traffic information in the 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putLoggingConfiguration

      default CompletableFuture<PutLoggingConfigurationResponse> putLoggingConfiguration(Consumer<PutLoggingConfigurationRequest.Builder> putLoggingConfigurationRequest)

      Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

      This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.

      To modify an existing logging configuration, do the following:

      1. Retrieve it by calling GetLoggingConfiguration

      2. Update its settings as needed

      3. Provide the complete logging configuration specification to this call

      You can define one logging destination per web ACL.

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

      1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

        The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

        For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.

      2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request.

      When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

      For additional information about web ACL logging, see Logging web ACL traffic information in the 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:
      A Java Future containing the result of the PutLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
      • WafServiceLinkedRoleErrorException 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 call to 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.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidOperationException The operation isn't valid.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafLogDestinationPermissionIssueException The operation failed because you don't have the permissions that your logging configuration requires. For information, see Logging web ACL traffic information in the 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putManagedRuleSetVersions

      default CompletableFuture<PutManagedRuleSetVersionsResponse> putManagedRuleSetVersions(PutManagedRuleSetVersionsRequest putManagedRuleSetVersionsRequest)

      Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.

      This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

      Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

      Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.

      To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.

      Parameters:
      putManagedRuleSetVersionsRequest -
      Returns:
      A Java Future containing the result of the PutManagedRuleSetVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putManagedRuleSetVersions

      default CompletableFuture<PutManagedRuleSetVersionsResponse> putManagedRuleSetVersions(Consumer<PutManagedRuleSetVersionsRequest.Builder> putManagedRuleSetVersionsRequest)

      Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.

      This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

      Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

      Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.

      To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.


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

      Parameters:
      putManagedRuleSetVersionsRequest - A Consumer that will call methods on PutManagedRuleSetVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutManagedRuleSetVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putPermissionPolicy

      default CompletableFuture<PutPermissionPolicyResponse> putPermissionPolicy(PutPermissionPolicyRequest putPermissionPolicyRequest)

      Use this to share a rule group with other accounts.

      This action attaches an IAM policy to the specified resource. You must be the owner of the rule group to perform this operation.

      This action is subject to the following restrictions:

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

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

      • The user making the request must be the owner of the rule group.

      If a rule group has been shared with your account, you can access it through the call GetRuleGroup, and you can reference it in CreateWebACL and UpdateWebACL. Rule groups that are shared with you don't appear in your WAF console rule groups listing.

      Parameters:
      putPermissionPolicyRequest -
      Returns:
      A Java Future containing the result of the PutPermissionPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidPermissionPolicyException The operation failed because the specified policy isn't in the proper format.

          The policy specifications must conform to the following:

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

          • The policy must include specifications for Effect, Action, and Principal.

          • Effect must specify Allow.

          • Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF rejects any extra actions or wildcard actions in the policy.

          • The policy must not include a Resource parameter.

          For more information, see IAM Policies.

        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putPermissionPolicy

      default CompletableFuture<PutPermissionPolicyResponse> putPermissionPolicy(Consumer<PutPermissionPolicyRequest.Builder> putPermissionPolicyRequest)

      Use this to share a rule group with other accounts.

      This action attaches an IAM policy to the specified resource. You must be the owner of the rule group to perform this operation.

      This action is subject to the following restrictions:

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

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

      • The user making the request must be the owner of the rule group.

      If a rule group has been shared with your account, you can access it through the call GetRuleGroup, and you can reference it in CreateWebACL and UpdateWebACL. Rule groups that are shared with you don't appear in your WAF console rule groups listing.


      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:
      A Java Future containing the result of the PutPermissionPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafInvalidPermissionPolicyException The operation failed because the specified policy isn't in the proper format.

          The policy specifications must conform to the following:

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

          • The policy must include specifications for Effect, Action, and Principal.

          • Effect must specify Allow.

          • Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF rejects any extra actions or wildcard actions in the policy.

          • The policy must not include a Resource parameter.

          For more information, see IAM Policies.

        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Associates tags with the specified Amazon Web Services 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 Amazon Web Services resource, up to 50 tags for a resource.

      You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Associates tags with the specified Amazon Web Services 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 Amazon Web Services resource, up to 50 tags for a resource.

      You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.


      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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafTagOperationException An error occurred during the tagging operation. Retry your request.
        • WafTagOperationInternalErrorException WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateIPSet

      default CompletableFuture<UpdateIpSetResponse> updateIPSet(UpdateIpSetRequest updateIpSetRequest)

      Updates the specified IPSet.

      This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.

      To modify an IP set, do the following:

      1. Retrieve it by calling GetIPSet

      2. Update its settings as needed

      3. Provide the complete IP set specification to this call

      Temporary inconsistencies during updates

      When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

      The following are examples of the temporary inconsistencies that you might notice during change propagation:

      • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

      • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

      • After you change a rule action setting, you might see the old action in some places and the new action in others.

      • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

      Parameters:
      updateIpSetRequest -
      Returns:
      A Java Future containing the result of the UpdateIPSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateIPSet

      default CompletableFuture<UpdateIpSetResponse> updateIPSet(Consumer<UpdateIpSetRequest.Builder> updateIpSetRequest)

      Updates the specified IPSet.

      This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.

      To modify an IP set, do the following:

      1. Retrieve it by calling GetIPSet

      2. Update its settings as needed

      3. Provide the complete IP set specification to this call

      Temporary inconsistencies during updates

      When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

      The following are examples of the temporary inconsistencies that you might notice during change propagation:

      • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

      • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

      • After you change a rule action setting, you might see the old action in some places and the new action in others.

      • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.


      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:
      A Java Future containing the result of the UpdateIPSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateManagedRuleSetVersionExpiryDate

      default CompletableFuture<UpdateManagedRuleSetVersionExpiryDateResponse> updateManagedRuleSetVersionExpiryDate(UpdateManagedRuleSetVersionExpiryDateRequest updateManagedRuleSetVersionExpiryDateRequest)

      Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.

      This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

      Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

      Parameters:
      updateManagedRuleSetVersionExpiryDateRequest -
      Returns:
      A Java Future containing the result of the UpdateManagedRuleSetVersionExpiryDate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateManagedRuleSetVersionExpiryDate

      default CompletableFuture<UpdateManagedRuleSetVersionExpiryDateResponse> updateManagedRuleSetVersionExpiryDate(Consumer<UpdateManagedRuleSetVersionExpiryDateRequest.Builder> updateManagedRuleSetVersionExpiryDateRequest)

      Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.

      This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

      Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.


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

      Parameters:
      updateManagedRuleSetVersionExpiryDateRequest - A Consumer that will call methods on UpdateManagedRuleSetVersionExpiryDateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateManagedRuleSetVersionExpiryDate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRegexPatternSet

      default CompletableFuture<UpdateRegexPatternSetResponse> updateRegexPatternSet(UpdateRegexPatternSetRequest updateRegexPatternSetRequest)

      Updates the specified RegexPatternSet.

      This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.

      To modify a regex pattern set, do the following:

      1. Retrieve it by calling GetRegexPatternSet

      2. Update its settings as needed

      3. Provide the complete regex pattern set specification to this call

      Temporary inconsistencies during updates

      When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

      The following are examples of the temporary inconsistencies that you might notice during change propagation:

      • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

      • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

      • After you change a rule action setting, you might see the old action in some places and the new action in others.

      • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

      Parameters:
      updateRegexPatternSetRequest -
      Returns:
      A Java Future containing the result of the UpdateRegexPatternSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRegexPatternSet

      default CompletableFuture<UpdateRegexPatternSetResponse> updateRegexPatternSet(Consumer<UpdateRegexPatternSetRequest.Builder> updateRegexPatternSetRequest)

      Updates the specified RegexPatternSet.

      This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.

      To modify a regex pattern set, do the following:

      1. Retrieve it by calling GetRegexPatternSet

      2. Update its settings as needed

      3. Provide the complete regex pattern set specification to this call

      Temporary inconsistencies during updates

      When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

      The following are examples of the temporary inconsistencies that you might notice during change propagation:

      • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

      • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

      • After you change a rule action setting, you might see the old action in some places and the new action in others.

      • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.


      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:
      A Java Future containing the result of the UpdateRegexPatternSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafInvalidOperationException The operation isn't valid.
        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRuleGroup

      default CompletableFuture<UpdateRuleGroupResponse> updateRuleGroup(UpdateRuleGroupRequest updateRuleGroupRequest)

      Updates the specified RuleGroup.

      This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.

      To modify a rule group, do the following:

      1. Retrieve it by calling GetRuleGroup

      2. Update its settings as needed

      3. Provide the complete rule group specification to this call

      A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

      Temporary inconsistencies during updates

      When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

      The following are examples of the temporary inconsistencies that you might notice during change propagation:

      • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

      • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

      • After you change a rule action setting, you might see the old action in some places and the new action in others.

      • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

      Parameters:
      updateRuleGroupRequest -
      Returns:
      A Java Future containing the result of the UpdateRuleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
        • WafInvalidOperationException The operation isn't valid.
        • WafConfigurationWarningException The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration.

          Provide the handling configuration and retry your operation.

          Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value: true).

        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRuleGroup

      default CompletableFuture<UpdateRuleGroupResponse> updateRuleGroup(Consumer<UpdateRuleGroupRequest.Builder> updateRuleGroupRequest)

      Updates the specified RuleGroup.

      This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.

      To modify a rule group, do the following:

      1. Retrieve it by calling GetRuleGroup

      2. Update its settings as needed

      3. Provide the complete rule group specification to this call

      A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

      Temporary inconsistencies during updates

      When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

      The following are examples of the temporary inconsistencies that you might notice during change propagation:

      • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

      • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

      • After you change a rule action setting, you might see the old action in some places and the new action in others.

      • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.


      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:
      A Java Future containing the result of the UpdateRuleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
        • WafInvalidOperationException The operation isn't valid.
        • WafConfigurationWarningException The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration.

          Provide the handling configuration and retry your operation.

          Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value: true).

        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWebACL

      default CompletableFuture<UpdateWebAclResponse> updateWebACL(UpdateWebAclRequest updateWebAclRequest)

      Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.

      This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.

      To modify a web ACL, do the following:

      1. Retrieve it by calling GetWebACL

      2. Update its settings as needed

      3. Provide the complete web ACL specification to this call

      A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

      Temporary inconsistencies during updates

      When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

      The following are examples of the temporary inconsistencies that you might notice during change propagation:

      • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

      • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

      • After you change a rule action setting, you might see the old action in some places and the new action in others.

      • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

      Parameters:
      updateWebAclRequest -
      Returns:
      A Java Future containing the result of the UpdateWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafInvalidResourceException WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
        • WafInvalidOperationException The operation isn't valid.
        • WafExpiredManagedRuleGroupVersionException The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.
        • WafConfigurationWarningException The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration.

          Provide the handling configuration and retry your operation.

          Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value: true).

        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWebACL

      default CompletableFuture<UpdateWebAclResponse> updateWebACL(Consumer<UpdateWebAclRequest.Builder> updateWebAclRequest)

      Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.

      This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.

      To modify a web ACL, do the following:

      1. Retrieve it by calling GetWebACL

      2. Update its settings as needed

      3. Provide the complete web ACL specification to this call

      A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

      Temporary inconsistencies during updates

      When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

      The following are examples of the temporary inconsistencies that you might notice during change propagation:

      • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

      • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

      • After you change a rule action setting, you might see the old action in some places and the new action in others.

      • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.


      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:
      A Java Future containing the result of the UpdateWebACL operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • WafInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
      • WafInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example:

        • You specified a parameter name or value that isn't valid.

        • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

        • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

        • WafNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
        • WafDuplicateItemException WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
        • WafOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
        • WafLimitsExceededException WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
        • WafInvalidResourceException WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
        • WafUnavailableEntityException WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
        • WafSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
        • WafInvalidOperationException The operation isn't valid.
        • WafExpiredManagedRuleGroupVersionException The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.
        • WafConfigurationWarningException The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration.

          Provide the handling configuration and retry your operation.

          Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value: true).

        • 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.
        • Wafv2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default Wafv2ServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static Wafv2AsyncClient create()
      Create a Wafv2AsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static Wafv2AsyncClientBuilder builder()
      Create a builder that can be used to configure and create a Wafv2AsyncClient.