software.amazon.awssdk.services.wafv2.Wafv2AsyncClient Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.wafv2;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.wafv2.model.AssociateWebAclRequest;
import software.amazon.awssdk.services.wafv2.model.AssociateWebAclResponse;
import software.amazon.awssdk.services.wafv2.model.CheckCapacityRequest;
import software.amazon.awssdk.services.wafv2.model.CheckCapacityResponse;
import software.amazon.awssdk.services.wafv2.model.CreateApiKeyRequest;
import software.amazon.awssdk.services.wafv2.model.CreateApiKeyResponse;
import software.amazon.awssdk.services.wafv2.model.CreateIpSetRequest;
import software.amazon.awssdk.services.wafv2.model.CreateIpSetResponse;
import software.amazon.awssdk.services.wafv2.model.CreateRegexPatternSetRequest;
import software.amazon.awssdk.services.wafv2.model.CreateRegexPatternSetResponse;
import software.amazon.awssdk.services.wafv2.model.CreateRuleGroupRequest;
import software.amazon.awssdk.services.wafv2.model.CreateRuleGroupResponse;
import software.amazon.awssdk.services.wafv2.model.CreateWebAclRequest;
import software.amazon.awssdk.services.wafv2.model.CreateWebAclResponse;
import software.amazon.awssdk.services.wafv2.model.DeleteApiKeyRequest;
import software.amazon.awssdk.services.wafv2.model.DeleteApiKeyResponse;
import software.amazon.awssdk.services.wafv2.model.DeleteFirewallManagerRuleGroupsRequest;
import software.amazon.awssdk.services.wafv2.model.DeleteFirewallManagerRuleGroupsResponse;
import software.amazon.awssdk.services.wafv2.model.DeleteIpSetRequest;
import software.amazon.awssdk.services.wafv2.model.DeleteIpSetResponse;
import software.amazon.awssdk.services.wafv2.model.DeleteLoggingConfigurationRequest;
import software.amazon.awssdk.services.wafv2.model.DeleteLoggingConfigurationResponse;
import software.amazon.awssdk.services.wafv2.model.DeletePermissionPolicyRequest;
import software.amazon.awssdk.services.wafv2.model.DeletePermissionPolicyResponse;
import software.amazon.awssdk.services.wafv2.model.DeleteRegexPatternSetRequest;
import software.amazon.awssdk.services.wafv2.model.DeleteRegexPatternSetResponse;
import software.amazon.awssdk.services.wafv2.model.DeleteRuleGroupRequest;
import software.amazon.awssdk.services.wafv2.model.DeleteRuleGroupResponse;
import software.amazon.awssdk.services.wafv2.model.DeleteWebAclRequest;
import software.amazon.awssdk.services.wafv2.model.DeleteWebAclResponse;
import software.amazon.awssdk.services.wafv2.model.DescribeAllManagedProductsRequest;
import software.amazon.awssdk.services.wafv2.model.DescribeAllManagedProductsResponse;
import software.amazon.awssdk.services.wafv2.model.DescribeManagedProductsByVendorRequest;
import software.amazon.awssdk.services.wafv2.model.DescribeManagedProductsByVendorResponse;
import software.amazon.awssdk.services.wafv2.model.DescribeManagedRuleGroupRequest;
import software.amazon.awssdk.services.wafv2.model.DescribeManagedRuleGroupResponse;
import software.amazon.awssdk.services.wafv2.model.DisassociateWebAclRequest;
import software.amazon.awssdk.services.wafv2.model.DisassociateWebAclResponse;
import software.amazon.awssdk.services.wafv2.model.GenerateMobileSdkReleaseUrlRequest;
import software.amazon.awssdk.services.wafv2.model.GenerateMobileSdkReleaseUrlResponse;
import software.amazon.awssdk.services.wafv2.model.GetDecryptedApiKeyRequest;
import software.amazon.awssdk.services.wafv2.model.GetDecryptedApiKeyResponse;
import software.amazon.awssdk.services.wafv2.model.GetIpSetRequest;
import software.amazon.awssdk.services.wafv2.model.GetIpSetResponse;
import software.amazon.awssdk.services.wafv2.model.GetLoggingConfigurationRequest;
import software.amazon.awssdk.services.wafv2.model.GetLoggingConfigurationResponse;
import software.amazon.awssdk.services.wafv2.model.GetManagedRuleSetRequest;
import software.amazon.awssdk.services.wafv2.model.GetManagedRuleSetResponse;
import software.amazon.awssdk.services.wafv2.model.GetMobileSdkReleaseRequest;
import software.amazon.awssdk.services.wafv2.model.GetMobileSdkReleaseResponse;
import software.amazon.awssdk.services.wafv2.model.GetPermissionPolicyRequest;
import software.amazon.awssdk.services.wafv2.model.GetPermissionPolicyResponse;
import software.amazon.awssdk.services.wafv2.model.GetRateBasedStatementManagedKeysRequest;
import software.amazon.awssdk.services.wafv2.model.GetRateBasedStatementManagedKeysResponse;
import software.amazon.awssdk.services.wafv2.model.GetRegexPatternSetRequest;
import software.amazon.awssdk.services.wafv2.model.GetRegexPatternSetResponse;
import software.amazon.awssdk.services.wafv2.model.GetRuleGroupRequest;
import software.amazon.awssdk.services.wafv2.model.GetRuleGroupResponse;
import software.amazon.awssdk.services.wafv2.model.GetSampledRequestsRequest;
import software.amazon.awssdk.services.wafv2.model.GetSampledRequestsResponse;
import software.amazon.awssdk.services.wafv2.model.GetWebAclForResourceRequest;
import software.amazon.awssdk.services.wafv2.model.GetWebAclForResourceResponse;
import software.amazon.awssdk.services.wafv2.model.GetWebAclRequest;
import software.amazon.awssdk.services.wafv2.model.GetWebAclResponse;
import software.amazon.awssdk.services.wafv2.model.ListApiKeysRequest;
import software.amazon.awssdk.services.wafv2.model.ListApiKeysResponse;
import software.amazon.awssdk.services.wafv2.model.ListAvailableManagedRuleGroupVersionsRequest;
import software.amazon.awssdk.services.wafv2.model.ListAvailableManagedRuleGroupVersionsResponse;
import software.amazon.awssdk.services.wafv2.model.ListAvailableManagedRuleGroupsRequest;
import software.amazon.awssdk.services.wafv2.model.ListAvailableManagedRuleGroupsResponse;
import software.amazon.awssdk.services.wafv2.model.ListIpSetsRequest;
import software.amazon.awssdk.services.wafv2.model.ListIpSetsResponse;
import software.amazon.awssdk.services.wafv2.model.ListLoggingConfigurationsRequest;
import software.amazon.awssdk.services.wafv2.model.ListLoggingConfigurationsResponse;
import software.amazon.awssdk.services.wafv2.model.ListManagedRuleSetsRequest;
import software.amazon.awssdk.services.wafv2.model.ListManagedRuleSetsResponse;
import software.amazon.awssdk.services.wafv2.model.ListMobileSdkReleasesRequest;
import software.amazon.awssdk.services.wafv2.model.ListMobileSdkReleasesResponse;
import software.amazon.awssdk.services.wafv2.model.ListRegexPatternSetsRequest;
import software.amazon.awssdk.services.wafv2.model.ListRegexPatternSetsResponse;
import software.amazon.awssdk.services.wafv2.model.ListResourcesForWebAclRequest;
import software.amazon.awssdk.services.wafv2.model.ListResourcesForWebAclResponse;
import software.amazon.awssdk.services.wafv2.model.ListRuleGroupsRequest;
import software.amazon.awssdk.services.wafv2.model.ListRuleGroupsResponse;
import software.amazon.awssdk.services.wafv2.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.wafv2.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.wafv2.model.ListWebAcLsRequest;
import software.amazon.awssdk.services.wafv2.model.ListWebAcLsResponse;
import software.amazon.awssdk.services.wafv2.model.PutLoggingConfigurationRequest;
import software.amazon.awssdk.services.wafv2.model.PutLoggingConfigurationResponse;
import software.amazon.awssdk.services.wafv2.model.PutManagedRuleSetVersionsRequest;
import software.amazon.awssdk.services.wafv2.model.PutManagedRuleSetVersionsResponse;
import software.amazon.awssdk.services.wafv2.model.PutPermissionPolicyRequest;
import software.amazon.awssdk.services.wafv2.model.PutPermissionPolicyResponse;
import software.amazon.awssdk.services.wafv2.model.TagResourceRequest;
import software.amazon.awssdk.services.wafv2.model.TagResourceResponse;
import software.amazon.awssdk.services.wafv2.model.UntagResourceRequest;
import software.amazon.awssdk.services.wafv2.model.UntagResourceResponse;
import software.amazon.awssdk.services.wafv2.model.UpdateIpSetRequest;
import software.amazon.awssdk.services.wafv2.model.UpdateIpSetResponse;
import software.amazon.awssdk.services.wafv2.model.UpdateManagedRuleSetVersionExpiryDateRequest;
import software.amazon.awssdk.services.wafv2.model.UpdateManagedRuleSetVersionExpiryDateResponse;
import software.amazon.awssdk.services.wafv2.model.UpdateRegexPatternSetRequest;
import software.amazon.awssdk.services.wafv2.model.UpdateRegexPatternSetResponse;
import software.amazon.awssdk.services.wafv2.model.UpdateRuleGroupRequest;
import software.amazon.awssdk.services.wafv2.model.UpdateRuleGroupResponse;
import software.amazon.awssdk.services.wafv2.model.UpdateWebAclRequest;
import software.amazon.awssdk.services.wafv2.model.UpdateWebAclResponse;
/**
* Service client for accessing WAFV2 asynchronously. This can be created using the static {@link #builder()} method.
*
* 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.
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface Wafv2AsyncClient extends AwsClient {
String SERVICE_NAME = "wafv2";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "wafv2";
/**
*
* 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.
*
*
*
*
* @param associateWebAclRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.AssociateWebACL
* @see AWS API
* Documentation
*/
default CompletableFuture associateWebACL(AssociateWebAclRequest associateWebAclRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link AssociateWebAclRequest.Builder} avoiding the need
* to create one manually via {@link AssociateWebAclRequest#builder()}
*
*
* @param associateWebAclRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.AssociateWebAclRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.AssociateWebACL
* @see AWS API
* Documentation
*/
default CompletableFuture associateWebACL(
Consumer associateWebAclRequest) {
return associateWebACL(AssociateWebAclRequest.builder().applyMutation(associateWebAclRequest).build());
}
/**
*
* 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.
*
*
* @param checkCapacityRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.CheckCapacity
* @see AWS API
* Documentation
*/
default CompletableFuture checkCapacity(CheckCapacityRequest checkCapacityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CheckCapacityRequest.Builder} avoiding the need to
* create one manually via {@link CheckCapacityRequest#builder()}
*
*
* @param checkCapacityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.CheckCapacityRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.CheckCapacity
* @see AWS API
* Documentation
*/
default CompletableFuture checkCapacity(Consumer checkCapacityRequest) {
return checkCapacity(CheckCapacityRequest.builder().applyMutation(checkCapacityRequest).build());
}
/**
*
* 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.
*
*
* @param createApiKeyRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.CreateAPIKey
* @see AWS API
* Documentation
*/
default CompletableFuture createAPIKey(CreateApiKeyRequest createApiKeyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateApiKeyRequest.Builder} avoiding the need to
* create one manually via {@link CreateApiKeyRequest#builder()}
*
*
* @param createApiKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.CreateApiKeyRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.CreateAPIKey
* @see AWS API
* Documentation
*/
default CompletableFuture createAPIKey(Consumer createApiKeyRequest) {
return createAPIKey(CreateApiKeyRequest.builder().applyMutation(createApiKeyRequest).build());
}
/**
*
* 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.
*
*
* @param createIpSetRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.CreateIPSet
* @see AWS API
* Documentation
*/
default CompletableFuture createIPSet(CreateIpSetRequest createIpSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateIpSetRequest.Builder} avoiding the need to
* create one manually via {@link CreateIpSetRequest#builder()}
*
*
* @param createIpSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.CreateIpSetRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.CreateIPSet
* @see AWS API
* Documentation
*/
default CompletableFuture createIPSet(Consumer createIpSetRequest) {
return createIPSet(CreateIpSetRequest.builder().applyMutation(createIpSetRequest).build());
}
/**
*
* Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF
* inspect a web request component for the specified patterns.
*
*
* @param createRegexPatternSetRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.CreateRegexPatternSet
* @see AWS
* API Documentation
*/
default CompletableFuture createRegexPatternSet(
CreateRegexPatternSetRequest createRegexPatternSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateRegexPatternSetRequest.Builder} avoiding the
* need to create one manually via {@link CreateRegexPatternSetRequest#builder()}
*
*
* @param createRegexPatternSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.CreateRegexPatternSetRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.CreateRegexPatternSet
* @see AWS
* API Documentation
*/
default CompletableFuture createRegexPatternSet(
Consumer createRegexPatternSetRequest) {
return createRegexPatternSet(CreateRegexPatternSetRequest.builder().applyMutation(createRegexPatternSetRequest).build());
}
/**
*
* 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.
*
*
* @param createRuleGroupRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.CreateRuleGroup
* @see AWS API
* Documentation
*/
default CompletableFuture createRuleGroup(CreateRuleGroupRequest createRuleGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateRuleGroupRequest.Builder} avoiding the need
* to create one manually via {@link CreateRuleGroupRequest#builder()}
*
*
* @param createRuleGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.CreateRuleGroupRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.CreateRuleGroup
* @see AWS API
* Documentation
*/
default CompletableFuture createRuleGroup(
Consumer createRuleGroupRequest) {
return createRuleGroup(CreateRuleGroupRequest.builder().applyMutation(createRuleGroupRequest).build());
}
/**
*
* 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.
*
*
* @param createWebAclRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.CreateWebACL
* @see AWS API
* Documentation
*/
default CompletableFuture createWebACL(CreateWebAclRequest createWebAclRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateWebAclRequest.Builder} avoiding the need to
* create one manually via {@link CreateWebAclRequest#builder()}
*
*
* @param createWebAclRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.CreateWebAclRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.CreateWebACL
* @see AWS API
* Documentation
*/
default CompletableFuture createWebACL(Consumer createWebAclRequest) {
return createWebACL(CreateWebAclRequest.builder().applyMutation(createWebAclRequest).build());
}
/**
*
* 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.
*
*
* @param deleteApiKeyRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteAPIKey
* @see AWS API
* Documentation
*/
default CompletableFuture deleteAPIKey(DeleteApiKeyRequest deleteApiKeyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteApiKeyRequest.Builder} avoiding the need to
* create one manually via {@link DeleteApiKeyRequest#builder()}
*
*
* @param deleteApiKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.DeleteApiKeyRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteAPIKey
* @see AWS API
* Documentation
*/
default CompletableFuture deleteAPIKey(Consumer deleteApiKeyRequest) {
return deleteAPIKey(DeleteApiKeyRequest.builder().applyMutation(deleteApiKeyRequest).build());
}
/**
*
* 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.
*
*
* @param deleteFirewallManagerRuleGroupsRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteFirewallManagerRuleGroups
* @see AWS API Documentation
*/
default CompletableFuture deleteFirewallManagerRuleGroups(
DeleteFirewallManagerRuleGroupsRequest deleteFirewallManagerRuleGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteFirewallManagerRuleGroupsRequest.Builder}
* avoiding the need to create one manually via {@link DeleteFirewallManagerRuleGroupsRequest#builder()}
*
*
* @param deleteFirewallManagerRuleGroupsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.DeleteFirewallManagerRuleGroupsRequest.Builder} to
* create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteFirewallManagerRuleGroups
* @see AWS API Documentation
*/
default CompletableFuture deleteFirewallManagerRuleGroups(
Consumer deleteFirewallManagerRuleGroupsRequest) {
return deleteFirewallManagerRuleGroups(DeleteFirewallManagerRuleGroupsRequest.builder()
.applyMutation(deleteFirewallManagerRuleGroupsRequest).build());
}
/**
*
* Deletes the specified IPSet.
*
*
* @param deleteIpSetRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteIPSet
* @see AWS API
* Documentation
*/
default CompletableFuture deleteIPSet(DeleteIpSetRequest deleteIpSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified IPSet.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteIpSetRequest.Builder} avoiding the need to
* create one manually via {@link DeleteIpSetRequest#builder()}
*
*
* @param deleteIpSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.DeleteIpSetRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteIPSet
* @see AWS API
* Documentation
*/
default CompletableFuture deleteIPSet(Consumer deleteIpSetRequest) {
return deleteIPSet(DeleteIpSetRequest.builder().applyMutation(deleteIpSetRequest).build());
}
/**
*
* Deletes the LoggingConfiguration from the specified web ACL.
*
*
* @param deleteLoggingConfigurationRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteLoggingConfiguration
* @see AWS API Documentation
*/
default CompletableFuture deleteLoggingConfiguration(
DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the LoggingConfiguration from the specified web ACL.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteLoggingConfigurationRequest.Builder} avoiding
* the need to create one manually via {@link DeleteLoggingConfigurationRequest#builder()}
*
*
* @param deleteLoggingConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.DeleteLoggingConfigurationRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteLoggingConfiguration
* @see AWS API Documentation
*/
default CompletableFuture deleteLoggingConfiguration(
Consumer deleteLoggingConfigurationRequest) {
return deleteLoggingConfiguration(DeleteLoggingConfigurationRequest.builder()
.applyMutation(deleteLoggingConfigurationRequest).build());
}
/**
*
* Permanently deletes an IAM policy from the specified rule group.
*
*
* You must be the owner of the rule group to perform this operation.
*
*
* @param deletePermissionPolicyRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeletePermissionPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture deletePermissionPolicy(
DeletePermissionPolicyRequest deletePermissionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeletePermissionPolicyRequest.Builder} avoiding the
* need to create one manually via {@link DeletePermissionPolicyRequest#builder()}
*
*
* @param deletePermissionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.DeletePermissionPolicyRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeletePermissionPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture deletePermissionPolicy(
Consumer deletePermissionPolicyRequest) {
return deletePermissionPolicy(DeletePermissionPolicyRequest.builder().applyMutation(deletePermissionPolicyRequest)
.build());
}
/**
*
* Deletes the specified RegexPatternSet.
*
*
* @param deleteRegexPatternSetRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteRegexPatternSet
* @see AWS
* API Documentation
*/
default CompletableFuture deleteRegexPatternSet(
DeleteRegexPatternSetRequest deleteRegexPatternSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified RegexPatternSet.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRegexPatternSetRequest.Builder} avoiding the
* need to create one manually via {@link DeleteRegexPatternSetRequest#builder()}
*
*
* @param deleteRegexPatternSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.DeleteRegexPatternSetRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteRegexPatternSet
* @see AWS
* API Documentation
*/
default CompletableFuture deleteRegexPatternSet(
Consumer deleteRegexPatternSetRequest) {
return deleteRegexPatternSet(DeleteRegexPatternSetRequest.builder().applyMutation(deleteRegexPatternSetRequest).build());
}
/**
*
* Deletes the specified RuleGroup.
*
*
* @param deleteRuleGroupRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteRuleGroup
* @see AWS API
* Documentation
*/
default CompletableFuture deleteRuleGroup(DeleteRuleGroupRequest deleteRuleGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified RuleGroup.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRuleGroupRequest.Builder} avoiding the need
* to create one manually via {@link DeleteRuleGroupRequest#builder()}
*
*
* @param deleteRuleGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.DeleteRuleGroupRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteRuleGroup
* @see AWS API
* Documentation
*/
default CompletableFuture deleteRuleGroup(
Consumer deleteRuleGroupRequest) {
return deleteRuleGroup(DeleteRuleGroupRequest.builder().applyMutation(deleteRuleGroupRequest).build());
}
/**
*
* 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:
*
*
* -
*
* For regional resources, call ListResourcesForWebACL.
*
*
* -
*
* For Amazon CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId. For
* information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.
*
*
*
*
* -
*
* 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.
*
*
*
*
*
*
*
* @param deleteWebAclRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteWebACL
* @see AWS API
* Documentation
*/
default CompletableFuture deleteWebACL(DeleteWebAclRequest deleteWebAclRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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:
*
*
* -
*
* For regional resources, call ListResourcesForWebACL.
*
*
* -
*
* For Amazon CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId. For
* information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.
*
*
*
*
* -
*
* 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 {@link DeleteWebAclRequest.Builder} avoiding the need to
* create one manually via {@link DeleteWebAclRequest#builder()}
*
*
* @param deleteWebAclRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.DeleteWebAclRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DeleteWebACL
* @see AWS API
* Documentation
*/
default CompletableFuture deleteWebACL(Consumer deleteWebAclRequest) {
return deleteWebACL(DeleteWebAclRequest.builder().applyMutation(deleteWebAclRequest).build());
}
/**
*
* Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services
* Marketplace managed rule groups.
*
*
* @param describeAllManagedProductsRequest
* @return 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.
*
* - 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.
* - 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.
*
* @sample Wafv2AsyncClient.DescribeAllManagedProducts
* @see AWS API Documentation
*/
default CompletableFuture describeAllManagedProducts(
DescribeAllManagedProductsRequest describeAllManagedProductsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeAllManagedProductsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeAllManagedProductsRequest#builder()}
*
*
* @param describeAllManagedProductsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.DescribeAllManagedProductsRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
* - 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.
*
* @sample Wafv2AsyncClient.DescribeAllManagedProducts
* @see AWS API Documentation
*/
default CompletableFuture describeAllManagedProducts(
Consumer describeAllManagedProductsRequest) {
return describeAllManagedProducts(DescribeAllManagedProductsRequest.builder()
.applyMutation(describeAllManagedProductsRequest).build());
}
/**
*
* Provides high-level information for the managed rule groups owned by a specific vendor.
*
*
* @param describeManagedProductsByVendorRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DescribeManagedProductsByVendor
* @see AWS API Documentation
*/
default CompletableFuture describeManagedProductsByVendor(
DescribeManagedProductsByVendorRequest describeManagedProductsByVendorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Provides high-level information for the managed rule groups owned by a specific vendor.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeManagedProductsByVendorRequest.Builder}
* avoiding the need to create one manually via {@link DescribeManagedProductsByVendorRequest#builder()}
*
*
* @param describeManagedProductsByVendorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.DescribeManagedProductsByVendorRequest.Builder} to
* create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DescribeManagedProductsByVendor
* @see AWS API Documentation
*/
default CompletableFuture describeManagedProductsByVendor(
Consumer describeManagedProductsByVendorRequest) {
return describeManagedProductsByVendor(DescribeManagedProductsByVendorRequest.builder()
.applyMutation(describeManagedProductsByVendorRequest).build());
}
/**
*
* Provides high-level information for a managed rule group, including descriptions of the rules.
*
*
* @param describeManagedRuleGroupRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DescribeManagedRuleGroup
* @see AWS API Documentation
*/
default CompletableFuture describeManagedRuleGroup(
DescribeManagedRuleGroupRequest describeManagedRuleGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Provides high-level information for a managed rule group, including descriptions of the rules.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeManagedRuleGroupRequest.Builder} avoiding
* the need to create one manually via {@link DescribeManagedRuleGroupRequest#builder()}
*
*
* @param describeManagedRuleGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.DescribeManagedRuleGroupRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DescribeManagedRuleGroup
* @see AWS API Documentation
*/
default CompletableFuture describeManagedRuleGroup(
Consumer describeManagedRuleGroupRequest) {
return describeManagedRuleGroup(DescribeManagedRuleGroupRequest.builder().applyMutation(describeManagedRuleGroupRequest)
.build());
}
/**
*
* 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.
*
*
* @param disassociateWebAclRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DisassociateWebACL
* @see AWS API
* Documentation
*/
default CompletableFuture disassociateWebACL(DisassociateWebAclRequest disassociateWebAclRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DisassociateWebAclRequest.Builder} avoiding the
* need to create one manually via {@link DisassociateWebAclRequest#builder()}
*
*
* @param disassociateWebAclRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.DisassociateWebAclRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.DisassociateWebACL
* @see AWS API
* Documentation
*/
default CompletableFuture disassociateWebACL(
Consumer disassociateWebAclRequest) {
return disassociateWebACL(DisassociateWebAclRequest.builder().applyMutation(disassociateWebAclRequest).build());
}
/**
*
* 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.
*
*
* @param generateMobileSdkReleaseUrlRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GenerateMobileSdkReleaseUrl
* @see AWS API Documentation
*/
default CompletableFuture generateMobileSdkReleaseUrl(
GenerateMobileSdkReleaseUrlRequest generateMobileSdkReleaseUrlRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GenerateMobileSdkReleaseUrlRequest.Builder}
* avoiding the need to create one manually via {@link GenerateMobileSdkReleaseUrlRequest#builder()}
*
*
* @param generateMobileSdkReleaseUrlRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GenerateMobileSdkReleaseUrlRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GenerateMobileSdkReleaseUrl
* @see AWS API Documentation
*/
default CompletableFuture generateMobileSdkReleaseUrl(
Consumer generateMobileSdkReleaseUrlRequest) {
return generateMobileSdkReleaseUrl(GenerateMobileSdkReleaseUrlRequest.builder()
.applyMutation(generateMobileSdkReleaseUrlRequest).build());
}
/**
*
* 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.
*
*
* @param getDecryptedApiKeyRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetDecryptedAPIKey
* @see AWS API
* Documentation
*/
default CompletableFuture getDecryptedAPIKey(GetDecryptedApiKeyRequest getDecryptedApiKeyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetDecryptedApiKeyRequest.Builder} avoiding the
* need to create one manually via {@link GetDecryptedApiKeyRequest#builder()}
*
*
* @param getDecryptedApiKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GetDecryptedApiKeyRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetDecryptedAPIKey
* @see AWS API
* Documentation
*/
default CompletableFuture getDecryptedAPIKey(
Consumer getDecryptedApiKeyRequest) {
return getDecryptedAPIKey(GetDecryptedApiKeyRequest.builder().applyMutation(getDecryptedApiKeyRequest).build());
}
/**
*
* Retrieves the specified IPSet.
*
*
* @param getIpSetRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetIPSet
* @see AWS API
* Documentation
*/
default CompletableFuture getIPSet(GetIpSetRequest getIpSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the specified IPSet.
*
*
*
* This is a convenience which creates an instance of the {@link GetIpSetRequest.Builder} avoiding the need to
* create one manually via {@link GetIpSetRequest#builder()}
*
*
* @param getIpSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GetIpSetRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetIPSet
* @see AWS API
* Documentation
*/
default CompletableFuture getIPSet(Consumer getIpSetRequest) {
return getIPSet(GetIpSetRequest.builder().applyMutation(getIpSetRequest).build());
}
/**
*
* Returns the LoggingConfiguration for the specified web ACL.
*
*
* @param getLoggingConfigurationRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetLoggingConfiguration
* @see AWS
* API Documentation
*/
default CompletableFuture getLoggingConfiguration(
GetLoggingConfigurationRequest getLoggingConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the LoggingConfiguration for the specified web ACL.
*
*
*
* This is a convenience which creates an instance of the {@link GetLoggingConfigurationRequest.Builder} avoiding
* the need to create one manually via {@link GetLoggingConfigurationRequest#builder()}
*
*
* @param getLoggingConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GetLoggingConfigurationRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetLoggingConfiguration
* @see AWS
* API Documentation
*/
default CompletableFuture getLoggingConfiguration(
Consumer getLoggingConfigurationRequest) {
return getLoggingConfiguration(GetLoggingConfigurationRequest.builder().applyMutation(getLoggingConfigurationRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param getManagedRuleSetRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetManagedRuleSet
* @see AWS API
* Documentation
*/
default CompletableFuture getManagedRuleSet(GetManagedRuleSetRequest getManagedRuleSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetManagedRuleSetRequest.Builder} avoiding the need
* to create one manually via {@link GetManagedRuleSetRequest#builder()}
*
*
* @param getManagedRuleSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GetManagedRuleSetRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetManagedRuleSet
* @see AWS API
* Documentation
*/
default CompletableFuture getManagedRuleSet(
Consumer getManagedRuleSetRequest) {
return getManagedRuleSet(GetManagedRuleSetRequest.builder().applyMutation(getManagedRuleSetRequest).build());
}
/**
*
* 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.
*
*
* @param getMobileSdkReleaseRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetMobileSdkRelease
* @see AWS API
* Documentation
*/
default CompletableFuture getMobileSdkRelease(
GetMobileSdkReleaseRequest getMobileSdkReleaseRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetMobileSdkReleaseRequest.Builder} avoiding the
* need to create one manually via {@link GetMobileSdkReleaseRequest#builder()}
*
*
* @param getMobileSdkReleaseRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GetMobileSdkReleaseRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetMobileSdkRelease
* @see AWS API
* Documentation
*/
default CompletableFuture getMobileSdkRelease(
Consumer getMobileSdkReleaseRequest) {
return getMobileSdkRelease(GetMobileSdkReleaseRequest.builder().applyMutation(getMobileSdkReleaseRequest).build());
}
/**
*
* 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.
*
*
* @param getPermissionPolicyRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetPermissionPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture getPermissionPolicy(
GetPermissionPolicyRequest getPermissionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetPermissionPolicyRequest.Builder} avoiding the
* need to create one manually via {@link GetPermissionPolicyRequest#builder()}
*
*
* @param getPermissionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GetPermissionPolicyRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetPermissionPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture getPermissionPolicy(
Consumer getPermissionPolicyRequest) {
return getPermissionPolicy(GetPermissionPolicyRequest.builder().applyMutation(getPermissionPolicyRequest).build());
}
/**
*
* 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.
*
*
* @param getRateBasedStatementManagedKeysRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetRateBasedStatementManagedKeys
* @see AWS API Documentation
*/
default CompletableFuture getRateBasedStatementManagedKeys(
GetRateBasedStatementManagedKeysRequest getRateBasedStatementManagedKeysRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetRateBasedStatementManagedKeysRequest.Builder}
* avoiding the need to create one manually via {@link GetRateBasedStatementManagedKeysRequest#builder()}
*
*
* @param getRateBasedStatementManagedKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GetRateBasedStatementManagedKeysRequest.Builder} to
* create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetRateBasedStatementManagedKeys
* @see AWS API Documentation
*/
default CompletableFuture getRateBasedStatementManagedKeys(
Consumer getRateBasedStatementManagedKeysRequest) {
return getRateBasedStatementManagedKeys(GetRateBasedStatementManagedKeysRequest.builder()
.applyMutation(getRateBasedStatementManagedKeysRequest).build());
}
/**
*
* Retrieves the specified RegexPatternSet.
*
*
* @param getRegexPatternSetRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetRegexPatternSet
* @see AWS API
* Documentation
*/
default CompletableFuture getRegexPatternSet(GetRegexPatternSetRequest getRegexPatternSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the specified RegexPatternSet.
*
*
*
* This is a convenience which creates an instance of the {@link GetRegexPatternSetRequest.Builder} avoiding the
* need to create one manually via {@link GetRegexPatternSetRequest#builder()}
*
*
* @param getRegexPatternSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GetRegexPatternSetRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetRegexPatternSet
* @see AWS API
* Documentation
*/
default CompletableFuture getRegexPatternSet(
Consumer getRegexPatternSetRequest) {
return getRegexPatternSet(GetRegexPatternSetRequest.builder().applyMutation(getRegexPatternSetRequest).build());
}
/**
*
* Retrieves the specified RuleGroup.
*
*
* @param getRuleGroupRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetRuleGroup
* @see AWS API
* Documentation
*/
default CompletableFuture getRuleGroup(GetRuleGroupRequest getRuleGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the specified RuleGroup.
*
*
*
* This is a convenience which creates an instance of the {@link GetRuleGroupRequest.Builder} avoiding the need to
* create one manually via {@link GetRuleGroupRequest#builder()}
*
*
* @param getRuleGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GetRuleGroupRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetRuleGroup
* @see AWS API
* Documentation
*/
default CompletableFuture getRuleGroup(Consumer getRuleGroupRequest) {
return getRuleGroup(GetRuleGroupRequest.builder().applyMutation(getRuleGroupRequest).build());
}
/**
*
* 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.
*
*
* @param getSampledRequestsRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetSampledRequests
* @see AWS API
* Documentation
*/
default CompletableFuture getSampledRequests(GetSampledRequestsRequest getSampledRequestsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetSampledRequestsRequest.Builder} avoiding the
* need to create one manually via {@link GetSampledRequestsRequest#builder()}
*
*
* @param getSampledRequestsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GetSampledRequestsRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetSampledRequests
* @see AWS API
* Documentation
*/
default CompletableFuture getSampledRequests(
Consumer getSampledRequestsRequest) {
return getSampledRequests(GetSampledRequestsRequest.builder().applyMutation(getSampledRequestsRequest).build());
}
/**
*
* Retrieves the specified WebACL.
*
*
* @param getWebAclRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetWebACL
* @see AWS API
* Documentation
*/
default CompletableFuture getWebACL(GetWebAclRequest getWebAclRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the specified WebACL.
*
*
*
* This is a convenience which creates an instance of the {@link GetWebAclRequest.Builder} avoiding the need to
* create one manually via {@link GetWebAclRequest#builder()}
*
*
* @param getWebAclRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GetWebAclRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetWebACL
* @see AWS API
* Documentation
*/
default CompletableFuture getWebACL(Consumer getWebAclRequest) {
return getWebACL(GetWebAclRequest.builder().applyMutation(getWebAclRequest).build());
}
/**
*
* 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.
*
*
* @param getWebAclForResourceRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetWebACLForResource
* @see AWS
* API Documentation
*/
default CompletableFuture getWebACLForResource(
GetWebAclForResourceRequest getWebAclForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetWebAclForResourceRequest.Builder} avoiding the
* need to create one manually via {@link GetWebAclForResourceRequest#builder()}
*
*
* @param getWebAclForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.GetWebAclForResourceRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.GetWebACLForResource
* @see AWS
* API Documentation
*/
default CompletableFuture getWebACLForResource(
Consumer getWebAclForResourceRequest) {
return getWebACLForResource(GetWebAclForResourceRequest.builder().applyMutation(getWebAclForResourceRequest).build());
}
/**
*
* 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.
*
*
* @param listApiKeysRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListAPIKeys
* @see AWS API
* Documentation
*/
default CompletableFuture listAPIKeys(ListApiKeysRequest listApiKeysRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListApiKeysRequest.Builder} avoiding the need to
* create one manually via {@link ListApiKeysRequest#builder()}
*
*
* @param listApiKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ListApiKeysRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListAPIKeys
* @see AWS API
* Documentation
*/
default CompletableFuture listAPIKeys(Consumer listApiKeysRequest) {
return listAPIKeys(ListApiKeysRequest.builder().applyMutation(listApiKeysRequest).build());
}
/**
*
* Returns a list of the available versions for the specified managed rule group.
*
*
* @param listAvailableManagedRuleGroupVersionsRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListAvailableManagedRuleGroupVersions
* @see AWS API Documentation
*/
default CompletableFuture listAvailableManagedRuleGroupVersions(
ListAvailableManagedRuleGroupVersionsRequest listAvailableManagedRuleGroupVersionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of the available versions for the specified managed rule group.
*
*
*
* This is a convenience which creates an instance of the
* {@link ListAvailableManagedRuleGroupVersionsRequest.Builder} avoiding the need to create one manually via
* {@link ListAvailableManagedRuleGroupVersionsRequest#builder()}
*
*
* @param listAvailableManagedRuleGroupVersionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ListAvailableManagedRuleGroupVersionsRequest.Builder}
* to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListAvailableManagedRuleGroupVersions
* @see AWS API Documentation
*/
default CompletableFuture listAvailableManagedRuleGroupVersions(
Consumer listAvailableManagedRuleGroupVersionsRequest) {
return listAvailableManagedRuleGroupVersions(ListAvailableManagedRuleGroupVersionsRequest.builder()
.applyMutation(listAvailableManagedRuleGroupVersionsRequest).build());
}
/**
*
* 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.
*
*
* @param listAvailableManagedRuleGroupsRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListAvailableManagedRuleGroups
* @see AWS API Documentation
*/
default CompletableFuture listAvailableManagedRuleGroups(
ListAvailableManagedRuleGroupsRequest listAvailableManagedRuleGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListAvailableManagedRuleGroupsRequest.Builder}
* avoiding the need to create one manually via {@link ListAvailableManagedRuleGroupsRequest#builder()}
*
*
* @param listAvailableManagedRuleGroupsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ListAvailableManagedRuleGroupsRequest.Builder} to
* create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListAvailableManagedRuleGroups
* @see AWS API Documentation
*/
default CompletableFuture listAvailableManagedRuleGroups(
Consumer listAvailableManagedRuleGroupsRequest) {
return listAvailableManagedRuleGroups(ListAvailableManagedRuleGroupsRequest.builder()
.applyMutation(listAvailableManagedRuleGroupsRequest).build());
}
/**
*
* Retrieves an array of IPSetSummary objects for the IP sets that you manage.
*
*
* @param listIpSetsRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListIPSets
* @see AWS API
* Documentation
*/
default CompletableFuture listIPSets(ListIpSetsRequest listIpSetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves an array of IPSetSummary objects for the IP sets that you manage.
*
*
*
* This is a convenience which creates an instance of the {@link ListIpSetsRequest.Builder} avoiding the need to
* create one manually via {@link ListIpSetsRequest#builder()}
*
*
* @param listIpSetsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ListIpSetsRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListIPSets
* @see AWS API
* Documentation
*/
default CompletableFuture listIPSets(Consumer listIpSetsRequest) {
return listIPSets(ListIpSetsRequest.builder().applyMutation(listIpSetsRequest).build());
}
/**
*
* Retrieves an array of your LoggingConfiguration objects.
*
*
* @param listLoggingConfigurationsRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListLoggingConfigurations
* @see AWS API Documentation
*/
default CompletableFuture listLoggingConfigurations(
ListLoggingConfigurationsRequest listLoggingConfigurationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves an array of your LoggingConfiguration objects.
*
*
*
* This is a convenience which creates an instance of the {@link ListLoggingConfigurationsRequest.Builder} avoiding
* the need to create one manually via {@link ListLoggingConfigurationsRequest#builder()}
*
*
* @param listLoggingConfigurationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ListLoggingConfigurationsRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListLoggingConfigurations
* @see AWS API Documentation
*/
default CompletableFuture listLoggingConfigurations(
Consumer listLoggingConfigurationsRequest) {
return listLoggingConfigurations(ListLoggingConfigurationsRequest.builder()
.applyMutation(listLoggingConfigurationsRequest).build());
}
/**
*
* 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.
*
*
*
* @param listManagedRuleSetsRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListManagedRuleSets
* @see AWS API
* Documentation
*/
default CompletableFuture listManagedRuleSets(
ListManagedRuleSetsRequest listManagedRuleSetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListManagedRuleSetsRequest.Builder} avoiding the
* need to create one manually via {@link ListManagedRuleSetsRequest#builder()}
*
*
* @param listManagedRuleSetsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ListManagedRuleSetsRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListManagedRuleSets
* @see AWS API
* Documentation
*/
default CompletableFuture listManagedRuleSets(
Consumer listManagedRuleSetsRequest) {
return listManagedRuleSets(ListManagedRuleSetsRequest.builder().applyMutation(listManagedRuleSetsRequest).build());
}
/**
*
* 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.
*
*
* @param listMobileSdkReleasesRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListMobileSdkReleases
* @see AWS
* API Documentation
*/
default CompletableFuture listMobileSdkReleases(
ListMobileSdkReleasesRequest listMobileSdkReleasesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListMobileSdkReleasesRequest.Builder} avoiding the
* need to create one manually via {@link ListMobileSdkReleasesRequest#builder()}
*
*
* @param listMobileSdkReleasesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ListMobileSdkReleasesRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListMobileSdkReleases
* @see AWS
* API Documentation
*/
default CompletableFuture listMobileSdkReleases(
Consumer listMobileSdkReleasesRequest) {
return listMobileSdkReleases(ListMobileSdkReleasesRequest.builder().applyMutation(listMobileSdkReleasesRequest).build());
}
/**
*
* Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
*
*
* @param listRegexPatternSetsRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListRegexPatternSets
* @see AWS
* API Documentation
*/
default CompletableFuture listRegexPatternSets(
ListRegexPatternSetsRequest listRegexPatternSetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
*
*
*
* This is a convenience which creates an instance of the {@link ListRegexPatternSetsRequest.Builder} avoiding the
* need to create one manually via {@link ListRegexPatternSetsRequest#builder()}
*
*
* @param listRegexPatternSetsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ListRegexPatternSetsRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListRegexPatternSets
* @see AWS
* API Documentation
*/
default CompletableFuture listRegexPatternSets(
Consumer listRegexPatternSetsRequest) {
return listRegexPatternSets(ListRegexPatternSetsRequest.builder().applyMutation(listRegexPatternSetsRequest).build());
}
/**
*
* 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.
*
*
* @param listResourcesForWebAclRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListResourcesForWebACL
* @see AWS
* API Documentation
*/
default CompletableFuture listResourcesForWebACL(
ListResourcesForWebAclRequest listResourcesForWebAclRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListResourcesForWebAclRequest.Builder} avoiding the
* need to create one manually via {@link ListResourcesForWebAclRequest#builder()}
*
*
* @param listResourcesForWebAclRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ListResourcesForWebAclRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListResourcesForWebACL
* @see AWS
* API Documentation
*/
default CompletableFuture listResourcesForWebACL(
Consumer listResourcesForWebAclRequest) {
return listResourcesForWebACL(ListResourcesForWebAclRequest.builder().applyMutation(listResourcesForWebAclRequest)
.build());
}
/**
*
* Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
*
*
* @param listRuleGroupsRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListRuleGroups
* @see AWS API
* Documentation
*/
default CompletableFuture listRuleGroups(ListRuleGroupsRequest listRuleGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
*
*
*
* This is a convenience which creates an instance of the {@link ListRuleGroupsRequest.Builder} avoiding the need to
* create one manually via {@link ListRuleGroupsRequest#builder()}
*
*
* @param listRuleGroupsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ListRuleGroupsRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListRuleGroups
* @see AWS API
* Documentation
*/
default CompletableFuture listRuleGroups(Consumer listRuleGroupsRequest) {
return listRuleGroups(ListRuleGroupsRequest.builder().applyMutation(listRuleGroupsRequest).build());
}
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ListTagsForResourceRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
*
*
* @param listWebAcLsRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListWebACLs
* @see AWS API
* Documentation
*/
default CompletableFuture listWebACLs(ListWebAcLsRequest listWebAcLsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
*
*
*
* This is a convenience which creates an instance of the {@link ListWebAcLsRequest.Builder} avoiding the need to
* create one manually via {@link ListWebAcLsRequest#builder()}
*
*
* @param listWebAcLsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ListWebAcLsRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.ListWebACLs
* @see AWS API
* Documentation
*/
default CompletableFuture listWebACLs(Consumer listWebAcLsRequest) {
return listWebACLs(ListWebAcLsRequest.builder().applyMutation(listWebAcLsRequest).build());
}
/**
*
* 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:
*
*
* -
*
* Retrieve it by calling GetLoggingConfiguration
*
*
* -
*
* Update its settings as needed
*
*
* -
*
* 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:
*
*
* -
*
* 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.
*
*
* -
*
* 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.
*
*
* @param putLoggingConfigurationRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.PutLoggingConfiguration
* @see AWS
* API Documentation
*/
default CompletableFuture putLoggingConfiguration(
PutLoggingConfigurationRequest putLoggingConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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:
*
*
* -
*
* Retrieve it by calling GetLoggingConfiguration
*
*
* -
*
* Update its settings as needed
*
*
* -
*
* 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:
*
*
* -
*
* 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.
*
*
* -
*
* 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 {@link PutLoggingConfigurationRequest.Builder} avoiding
* the need to create one manually via {@link PutLoggingConfigurationRequest#builder()}
*
*
* @param putLoggingConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.PutLoggingConfigurationRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.PutLoggingConfiguration
* @see AWS
* API Documentation
*/
default CompletableFuture putLoggingConfiguration(
Consumer putLoggingConfigurationRequest) {
return putLoggingConfiguration(PutLoggingConfigurationRequest.builder().applyMutation(putLoggingConfigurationRequest)
.build());
}
/**
*
* 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.
*
*
* @param putManagedRuleSetVersionsRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.PutManagedRuleSetVersions
* @see AWS API Documentation
*/
default CompletableFuture putManagedRuleSetVersions(
PutManagedRuleSetVersionsRequest putManagedRuleSetVersionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutManagedRuleSetVersionsRequest.Builder} avoiding
* the need to create one manually via {@link PutManagedRuleSetVersionsRequest#builder()}
*
*
* @param putManagedRuleSetVersionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.PutManagedRuleSetVersionsRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.PutManagedRuleSetVersions
* @see AWS API Documentation
*/
default CompletableFuture putManagedRuleSetVersions(
Consumer putManagedRuleSetVersionsRequest) {
return putManagedRuleSetVersions(PutManagedRuleSetVersionsRequest.builder()
.applyMutation(putManagedRuleSetVersionsRequest).build());
}
/**
*
* Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.
*
*
* 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.
*
*
*
*
* @param putPermissionPolicyRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.PutPermissionPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putPermissionPolicy(
PutPermissionPolicyRequest putPermissionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.
*
*
* 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.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutPermissionPolicyRequest.Builder} avoiding the
* need to create one manually via {@link PutPermissionPolicyRequest#builder()}
*
*
* @param putPermissionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.PutPermissionPolicyRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.PutPermissionPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putPermissionPolicy(
Consumer putPermissionPolicyRequest) {
return putPermissionPolicy(PutPermissionPolicyRequest.builder().applyMutation(putPermissionPolicyRequest).build());
}
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.TagResourceRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* 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.
*
*
* @param untagResourceRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.UntagResourceRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* 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:
*
*
* -
*
* Retrieve it by calling GetIPSet
*
*
* -
*
* Update its settings as needed
*
*
* -
*
* 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.
*
*
*
*
* @param updateIpSetRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.UpdateIPSet
* @see AWS API
* Documentation
*/
default CompletableFuture updateIPSet(UpdateIpSetRequest updateIpSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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:
*
*
* -
*
* Retrieve it by calling GetIPSet
*
*
* -
*
* Update its settings as needed
*
*
* -
*
* 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 {@link UpdateIpSetRequest.Builder} avoiding the need to
* create one manually via {@link UpdateIpSetRequest#builder()}
*
*
* @param updateIpSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.UpdateIpSetRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.UpdateIPSet
* @see AWS API
* Documentation
*/
default CompletableFuture updateIPSet(Consumer updateIpSetRequest) {
return updateIPSet(UpdateIpSetRequest.builder().applyMutation(updateIpSetRequest).build());
}
/**
*
* 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.
*
*
*
* @param updateManagedRuleSetVersionExpiryDateRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.UpdateManagedRuleSetVersionExpiryDate
* @see AWS API Documentation
*/
default CompletableFuture updateManagedRuleSetVersionExpiryDate(
UpdateManagedRuleSetVersionExpiryDateRequest updateManagedRuleSetVersionExpiryDateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link UpdateManagedRuleSetVersionExpiryDateRequest.Builder} avoiding the need to create one manually via
* {@link UpdateManagedRuleSetVersionExpiryDateRequest#builder()}
*
*
* @param updateManagedRuleSetVersionExpiryDateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.UpdateManagedRuleSetVersionExpiryDateRequest.Builder}
* to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.UpdateManagedRuleSetVersionExpiryDate
* @see AWS API Documentation
*/
default CompletableFuture updateManagedRuleSetVersionExpiryDate(
Consumer updateManagedRuleSetVersionExpiryDateRequest) {
return updateManagedRuleSetVersionExpiryDate(UpdateManagedRuleSetVersionExpiryDateRequest.builder()
.applyMutation(updateManagedRuleSetVersionExpiryDateRequest).build());
}
/**
*
* 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:
*
*
* -
*
* Retrieve it by calling GetRegexPatternSet
*
*
* -
*
* Update its settings as needed
*
*
* -
*
* 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.
*
*
*
*
* @param updateRegexPatternSetRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.UpdateRegexPatternSet
* @see AWS
* API Documentation
*/
default CompletableFuture updateRegexPatternSet(
UpdateRegexPatternSetRequest updateRegexPatternSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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:
*
*
* -
*
* Retrieve it by calling GetRegexPatternSet
*
*
* -
*
* Update its settings as needed
*
*
* -
*
* 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 {@link UpdateRegexPatternSetRequest.Builder} avoiding the
* need to create one manually via {@link UpdateRegexPatternSetRequest#builder()}
*
*
* @param updateRegexPatternSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.UpdateRegexPatternSetRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.UpdateRegexPatternSet
* @see AWS
* API Documentation
*/
default CompletableFuture updateRegexPatternSet(
Consumer updateRegexPatternSetRequest) {
return updateRegexPatternSet(UpdateRegexPatternSetRequest.builder().applyMutation(updateRegexPatternSetRequest).build());
}
/**
*
* 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:
*
*
* -
*
* Retrieve it by calling GetRuleGroup
*
*
* -
*
* Update its settings as needed
*
*
* -
*
* 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.
*
*
*
*
* @param updateRuleGroupRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.UpdateRuleGroup
* @see AWS API
* Documentation
*/
default CompletableFuture updateRuleGroup(UpdateRuleGroupRequest updateRuleGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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:
*
*
* -
*
* Retrieve it by calling GetRuleGroup
*
*
* -
*
* Update its settings as needed
*
*
* -
*
* 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 {@link UpdateRuleGroupRequest.Builder} avoiding the need
* to create one manually via {@link UpdateRuleGroupRequest#builder()}
*
*
* @param updateRuleGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.UpdateRuleGroupRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.UpdateRuleGroup
* @see AWS API
* Documentation
*/
default CompletableFuture updateRuleGroup(
Consumer updateRuleGroupRequest) {
return updateRuleGroup(UpdateRuleGroupRequest.builder().applyMutation(updateRuleGroupRequest).build());
}
/**
*
* 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:
*
*
* -
*
* Retrieve it by calling GetWebACL
*
*
* -
*
* Update its settings as needed
*
*
* -
*
* 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.
*
*
*
*
* @param updateWebAclRequest
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.UpdateWebACL
* @see AWS API
* Documentation
*/
default CompletableFuture updateWebACL(UpdateWebAclRequest updateWebAclRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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:
*
*
* -
*
* Retrieve it by calling GetWebACL
*
*
* -
*
* Update its settings as needed
*
*
* -
*
* 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 {@link UpdateWebAclRequest.Builder} avoiding the need to
* create one manually via {@link UpdateWebAclRequest#builder()}
*
*
* @param updateWebAclRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.UpdateWebAclRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample Wafv2AsyncClient.UpdateWebACL
* @see AWS API
* Documentation
*/
default CompletableFuture updateWebACL(Consumer updateWebAclRequest) {
return updateWebACL(UpdateWebAclRequest.builder().applyMutation(updateWebAclRequest).build());
}
@Override
default Wafv2ServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link Wafv2AsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static Wafv2AsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link Wafv2AsyncClient}.
*/
static Wafv2AsyncClientBuilder builder() {
return new DefaultWafv2AsyncClientBuilder();
}
}