Interface WafAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The
asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the
SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such
as credentials retrieval and endpoint discovery as part of the async API call.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
This is the AWS WAF Classic API Reference for using AWS WAF Classic with Amazon CloudFront. The AWS WAF Classic actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the AWS WAF Classic in the developer guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic WafAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aWafAsyncClient
.static WafAsyncClient
create()
Create aWafAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createByteMatchSet
(Consumer<CreateByteMatchSetRequest.Builder> createByteMatchSetRequest) createByteMatchSet
(CreateByteMatchSetRequest createByteMatchSetRequest) createGeoMatchSet
(Consumer<CreateGeoMatchSetRequest.Builder> createGeoMatchSetRequest) createGeoMatchSet
(CreateGeoMatchSetRequest createGeoMatchSetRequest) default CompletableFuture
<CreateIpSetResponse> createIPSet
(Consumer<CreateIpSetRequest.Builder> createIpSetRequest) default CompletableFuture
<CreateIpSetResponse> createIPSet
(CreateIpSetRequest createIpSetRequest) createRateBasedRule
(Consumer<CreateRateBasedRuleRequest.Builder> createRateBasedRuleRequest) createRateBasedRule
(CreateRateBasedRuleRequest createRateBasedRuleRequest) createRegexMatchSet
(Consumer<CreateRegexMatchSetRequest.Builder> createRegexMatchSetRequest) createRegexMatchSet
(CreateRegexMatchSetRequest createRegexMatchSetRequest) createRegexPatternSet
(Consumer<CreateRegexPatternSetRequest.Builder> createRegexPatternSetRequest) createRegexPatternSet
(CreateRegexPatternSetRequest createRegexPatternSetRequest) default CompletableFuture
<CreateRuleResponse> createRule
(Consumer<CreateRuleRequest.Builder> createRuleRequest) default CompletableFuture
<CreateRuleResponse> createRule
(CreateRuleRequest createRuleRequest) default CompletableFuture
<CreateRuleGroupResponse> createRuleGroup
(Consumer<CreateRuleGroupRequest.Builder> createRuleGroupRequest) default CompletableFuture
<CreateRuleGroupResponse> createRuleGroup
(CreateRuleGroupRequest createRuleGroupRequest) createSizeConstraintSet
(Consumer<CreateSizeConstraintSetRequest.Builder> createSizeConstraintSetRequest) createSizeConstraintSet
(CreateSizeConstraintSetRequest createSizeConstraintSetRequest) createSqlInjectionMatchSet
(Consumer<CreateSqlInjectionMatchSetRequest.Builder> createSqlInjectionMatchSetRequest) createSqlInjectionMatchSet
(CreateSqlInjectionMatchSetRequest createSqlInjectionMatchSetRequest) default CompletableFuture
<CreateWebAclResponse> createWebACL
(Consumer<CreateWebAclRequest.Builder> createWebAclRequest) default CompletableFuture
<CreateWebAclResponse> createWebACL
(CreateWebAclRequest createWebAclRequest) createWebACLMigrationStack
(Consumer<CreateWebAclMigrationStackRequest.Builder> createWebAclMigrationStackRequest) Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket.createWebACLMigrationStack
(CreateWebAclMigrationStackRequest createWebAclMigrationStackRequest) Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket.createXssMatchSet
(Consumer<CreateXssMatchSetRequest.Builder> createXssMatchSetRequest) createXssMatchSet
(CreateXssMatchSetRequest createXssMatchSetRequest) deleteByteMatchSet
(Consumer<DeleteByteMatchSetRequest.Builder> deleteByteMatchSetRequest) deleteByteMatchSet
(DeleteByteMatchSetRequest deleteByteMatchSetRequest) deleteGeoMatchSet
(Consumer<DeleteGeoMatchSetRequest.Builder> deleteGeoMatchSetRequest) deleteGeoMatchSet
(DeleteGeoMatchSetRequest deleteGeoMatchSetRequest) default CompletableFuture
<DeleteIpSetResponse> deleteIPSet
(Consumer<DeleteIpSetRequest.Builder> deleteIpSetRequest) default CompletableFuture
<DeleteIpSetResponse> deleteIPSet
(DeleteIpSetRequest deleteIpSetRequest) deleteLoggingConfiguration
(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest) deleteLoggingConfiguration
(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest) deletePermissionPolicy
(Consumer<DeletePermissionPolicyRequest.Builder> deletePermissionPolicyRequest) deletePermissionPolicy
(DeletePermissionPolicyRequest deletePermissionPolicyRequest) deleteRateBasedRule
(Consumer<DeleteRateBasedRuleRequest.Builder> deleteRateBasedRuleRequest) deleteRateBasedRule
(DeleteRateBasedRuleRequest deleteRateBasedRuleRequest) deleteRegexMatchSet
(Consumer<DeleteRegexMatchSetRequest.Builder> deleteRegexMatchSetRequest) deleteRegexMatchSet
(DeleteRegexMatchSetRequest deleteRegexMatchSetRequest) deleteRegexPatternSet
(Consumer<DeleteRegexPatternSetRequest.Builder> deleteRegexPatternSetRequest) deleteRegexPatternSet
(DeleteRegexPatternSetRequest deleteRegexPatternSetRequest) default CompletableFuture
<DeleteRuleResponse> deleteRule
(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) default CompletableFuture
<DeleteRuleResponse> deleteRule
(DeleteRuleRequest deleteRuleRequest) default CompletableFuture
<DeleteRuleGroupResponse> deleteRuleGroup
(Consumer<DeleteRuleGroupRequest.Builder> deleteRuleGroupRequest) default CompletableFuture
<DeleteRuleGroupResponse> deleteRuleGroup
(DeleteRuleGroupRequest deleteRuleGroupRequest) deleteSizeConstraintSet
(Consumer<DeleteSizeConstraintSetRequest.Builder> deleteSizeConstraintSetRequest) deleteSizeConstraintSet
(DeleteSizeConstraintSetRequest deleteSizeConstraintSetRequest) deleteSqlInjectionMatchSet
(Consumer<DeleteSqlInjectionMatchSetRequest.Builder> deleteSqlInjectionMatchSetRequest) deleteSqlInjectionMatchSet
(DeleteSqlInjectionMatchSetRequest deleteSqlInjectionMatchSetRequest) default CompletableFuture
<DeleteWebAclResponse> deleteWebACL
(Consumer<DeleteWebAclRequest.Builder> deleteWebAclRequest) default CompletableFuture
<DeleteWebAclResponse> deleteWebACL
(DeleteWebAclRequest deleteWebAclRequest) deleteXssMatchSet
(Consumer<DeleteXssMatchSetRequest.Builder> deleteXssMatchSetRequest) deleteXssMatchSet
(DeleteXssMatchSetRequest deleteXssMatchSetRequest) default CompletableFuture
<GetByteMatchSetResponse> getByteMatchSet
(Consumer<GetByteMatchSetRequest.Builder> getByteMatchSetRequest) default CompletableFuture
<GetByteMatchSetResponse> getByteMatchSet
(GetByteMatchSetRequest getByteMatchSetRequest) default CompletableFuture
<GetChangeTokenResponse> default CompletableFuture
<GetChangeTokenResponse> getChangeToken
(Consumer<GetChangeTokenRequest.Builder> getChangeTokenRequest) default CompletableFuture
<GetChangeTokenResponse> getChangeToken
(GetChangeTokenRequest getChangeTokenRequest) getChangeTokenStatus
(Consumer<GetChangeTokenStatusRequest.Builder> getChangeTokenStatusRequest) getChangeTokenStatus
(GetChangeTokenStatusRequest getChangeTokenStatusRequest) default CompletableFuture
<GetGeoMatchSetResponse> getGeoMatchSet
(Consumer<GetGeoMatchSetRequest.Builder> getGeoMatchSetRequest) default CompletableFuture
<GetGeoMatchSetResponse> getGeoMatchSet
(GetGeoMatchSetRequest getGeoMatchSetRequest) default CompletableFuture
<GetIpSetResponse> getIPSet
(Consumer<GetIpSetRequest.Builder> getIpSetRequest) default CompletableFuture
<GetIpSetResponse> getIPSet
(GetIpSetRequest getIpSetRequest) getLoggingConfiguration
(Consumer<GetLoggingConfigurationRequest.Builder> getLoggingConfigurationRequest) getLoggingConfiguration
(GetLoggingConfigurationRequest getLoggingConfigurationRequest) getPermissionPolicy
(Consumer<GetPermissionPolicyRequest.Builder> getPermissionPolicyRequest) getPermissionPolicy
(GetPermissionPolicyRequest getPermissionPolicyRequest) getRateBasedRule
(Consumer<GetRateBasedRuleRequest.Builder> getRateBasedRuleRequest) getRateBasedRule
(GetRateBasedRuleRequest getRateBasedRuleRequest) getRateBasedRuleManagedKeys
(Consumer<GetRateBasedRuleManagedKeysRequest.Builder> getRateBasedRuleManagedKeysRequest) getRateBasedRuleManagedKeys
(GetRateBasedRuleManagedKeysRequest getRateBasedRuleManagedKeysRequest) getRegexMatchSet
(Consumer<GetRegexMatchSetRequest.Builder> getRegexMatchSetRequest) getRegexMatchSet
(GetRegexMatchSetRequest getRegexMatchSetRequest) getRegexPatternSet
(Consumer<GetRegexPatternSetRequest.Builder> getRegexPatternSetRequest) getRegexPatternSet
(GetRegexPatternSetRequest getRegexPatternSetRequest) default CompletableFuture
<GetRuleResponse> getRule
(Consumer<GetRuleRequest.Builder> getRuleRequest) default CompletableFuture
<GetRuleResponse> getRule
(GetRuleRequest getRuleRequest) default CompletableFuture
<GetRuleGroupResponse> getRuleGroup
(Consumer<GetRuleGroupRequest.Builder> getRuleGroupRequest) default CompletableFuture
<GetRuleGroupResponse> getRuleGroup
(GetRuleGroupRequest getRuleGroupRequest) getSampledRequests
(Consumer<GetSampledRequestsRequest.Builder> getSampledRequestsRequest) getSampledRequests
(GetSampledRequestsRequest getSampledRequestsRequest) getSizeConstraintSet
(Consumer<GetSizeConstraintSetRequest.Builder> getSizeConstraintSetRequest) getSizeConstraintSet
(GetSizeConstraintSetRequest getSizeConstraintSetRequest) getSqlInjectionMatchSet
(Consumer<GetSqlInjectionMatchSetRequest.Builder> getSqlInjectionMatchSetRequest) getSqlInjectionMatchSet
(GetSqlInjectionMatchSetRequest getSqlInjectionMatchSetRequest) default CompletableFuture
<GetWebAclResponse> getWebACL
(Consumer<GetWebAclRequest.Builder> getWebAclRequest) default CompletableFuture
<GetWebAclResponse> getWebACL
(GetWebAclRequest getWebAclRequest) default CompletableFuture
<GetXssMatchSetResponse> getXssMatchSet
(Consumer<GetXssMatchSetRequest.Builder> getXssMatchSetRequest) default CompletableFuture
<GetXssMatchSetResponse> getXssMatchSet
(GetXssMatchSetRequest getXssMatchSetRequest) listActivatedRulesInRuleGroup
(Consumer<ListActivatedRulesInRuleGroupRequest.Builder> listActivatedRulesInRuleGroupRequest) listActivatedRulesInRuleGroup
(ListActivatedRulesInRuleGroupRequest listActivatedRulesInRuleGroupRequest) listByteMatchSets
(Consumer<ListByteMatchSetsRequest.Builder> listByteMatchSetsRequest) listByteMatchSets
(ListByteMatchSetsRequest listByteMatchSetsRequest) listGeoMatchSets
(Consumer<ListGeoMatchSetsRequest.Builder> listGeoMatchSetsRequest) listGeoMatchSets
(ListGeoMatchSetsRequest listGeoMatchSetsRequest) default CompletableFuture
<ListIpSetsResponse> default CompletableFuture
<ListIpSetsResponse> listIPSets
(Consumer<ListIpSetsRequest.Builder> listIpSetsRequest) default CompletableFuture
<ListIpSetsResponse> listIPSets
(ListIpSetsRequest listIpSetsRequest) listLoggingConfigurations
(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest) listLoggingConfigurations
(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest) listRateBasedRules
(Consumer<ListRateBasedRulesRequest.Builder> listRateBasedRulesRequest) listRateBasedRules
(ListRateBasedRulesRequest listRateBasedRulesRequest) listRegexMatchSets
(Consumer<ListRegexMatchSetsRequest.Builder> listRegexMatchSetsRequest) listRegexMatchSets
(ListRegexMatchSetsRequest listRegexMatchSetsRequest) listRegexPatternSets
(Consumer<ListRegexPatternSetsRequest.Builder> listRegexPatternSetsRequest) listRegexPatternSets
(ListRegexPatternSetsRequest listRegexPatternSetsRequest) default CompletableFuture
<ListRuleGroupsResponse> default CompletableFuture
<ListRuleGroupsResponse> listRuleGroups
(Consumer<ListRuleGroupsRequest.Builder> listRuleGroupsRequest) default CompletableFuture
<ListRuleGroupsResponse> listRuleGroups
(ListRuleGroupsRequest listRuleGroupsRequest) default CompletableFuture
<ListRulesResponse> default CompletableFuture
<ListRulesResponse> listRules
(Consumer<ListRulesRequest.Builder> listRulesRequest) default CompletableFuture
<ListRulesResponse> listRules
(ListRulesRequest listRulesRequest) listSizeConstraintSets
(Consumer<ListSizeConstraintSetsRequest.Builder> listSizeConstraintSetsRequest) listSizeConstraintSets
(ListSizeConstraintSetsRequest listSizeConstraintSetsRequest) listSqlInjectionMatchSets
(Consumer<ListSqlInjectionMatchSetsRequest.Builder> listSqlInjectionMatchSetsRequest) listSqlInjectionMatchSets
(ListSqlInjectionMatchSetsRequest listSqlInjectionMatchSetsRequest) listSubscribedRuleGroups
(Consumer<ListSubscribedRuleGroupsRequest.Builder> listSubscribedRuleGroupsRequest) listSubscribedRuleGroups
(ListSubscribedRuleGroupsRequest listSubscribedRuleGroupsRequest) listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) default CompletableFuture
<ListWebAcLsResponse> default CompletableFuture
<ListWebAcLsResponse> listWebACLs
(Consumer<ListWebAcLsRequest.Builder> listWebAcLsRequest) default CompletableFuture
<ListWebAcLsResponse> listWebACLs
(ListWebAcLsRequest listWebAcLsRequest) listXssMatchSets
(Consumer<ListXssMatchSetsRequest.Builder> listXssMatchSetsRequest) listXssMatchSets
(ListXssMatchSetsRequest listXssMatchSetsRequest) putLoggingConfiguration
(Consumer<PutLoggingConfigurationRequest.Builder> putLoggingConfigurationRequest) putLoggingConfiguration
(PutLoggingConfigurationRequest putLoggingConfigurationRequest) putPermissionPolicy
(Consumer<PutPermissionPolicyRequest.Builder> putPermissionPolicyRequest) putPermissionPolicy
(PutPermissionPolicyRequest putPermissionPolicyRequest) default WafServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) updateByteMatchSet
(Consumer<UpdateByteMatchSetRequest.Builder> updateByteMatchSetRequest) updateByteMatchSet
(UpdateByteMatchSetRequest updateByteMatchSetRequest) updateGeoMatchSet
(Consumer<UpdateGeoMatchSetRequest.Builder> updateGeoMatchSetRequest) updateGeoMatchSet
(UpdateGeoMatchSetRequest updateGeoMatchSetRequest) default CompletableFuture
<UpdateIpSetResponse> updateIPSet
(Consumer<UpdateIpSetRequest.Builder> updateIpSetRequest) default CompletableFuture
<UpdateIpSetResponse> updateIPSet
(UpdateIpSetRequest updateIpSetRequest) updateRateBasedRule
(Consumer<UpdateRateBasedRuleRequest.Builder> updateRateBasedRuleRequest) updateRateBasedRule
(UpdateRateBasedRuleRequest updateRateBasedRuleRequest) updateRegexMatchSet
(Consumer<UpdateRegexMatchSetRequest.Builder> updateRegexMatchSetRequest) updateRegexMatchSet
(UpdateRegexMatchSetRequest updateRegexMatchSetRequest) updateRegexPatternSet
(Consumer<UpdateRegexPatternSetRequest.Builder> updateRegexPatternSetRequest) updateRegexPatternSet
(UpdateRegexPatternSetRequest updateRegexPatternSetRequest) default CompletableFuture
<UpdateRuleResponse> updateRule
(Consumer<UpdateRuleRequest.Builder> updateRuleRequest) default CompletableFuture
<UpdateRuleResponse> updateRule
(UpdateRuleRequest updateRuleRequest) default CompletableFuture
<UpdateRuleGroupResponse> updateRuleGroup
(Consumer<UpdateRuleGroupRequest.Builder> updateRuleGroupRequest) default CompletableFuture
<UpdateRuleGroupResponse> updateRuleGroup
(UpdateRuleGroupRequest updateRuleGroupRequest) updateSizeConstraintSet
(Consumer<UpdateSizeConstraintSetRequest.Builder> updateSizeConstraintSetRequest) updateSizeConstraintSet
(UpdateSizeConstraintSetRequest updateSizeConstraintSetRequest) updateSqlInjectionMatchSet
(Consumer<UpdateSqlInjectionMatchSetRequest.Builder> updateSqlInjectionMatchSetRequest) updateSqlInjectionMatchSet
(UpdateSqlInjectionMatchSetRequest updateSqlInjectionMatchSetRequest) default CompletableFuture
<UpdateWebAclResponse> updateWebACL
(Consumer<UpdateWebAclRequest.Builder> updateWebAclRequest) default CompletableFuture
<UpdateWebAclResponse> updateWebACL
(UpdateWebAclRequest updateWebAclRequest) updateXssMatchSet
(Consumer<UpdateXssMatchSetRequest.Builder> updateXssMatchSetRequest) updateXssMatchSet
(UpdateXssMatchSetRequest updateXssMatchSetRequest) Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createByteMatchSet
default CompletableFuture<CreateByteMatchSetResponse> createByteMatchSet(CreateByteMatchSetRequest createByteMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a
ByteMatchSet
. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of theUser-Agent
header or the query string. For example, you can create aByteMatchSet
that matches any requests withUser-Agent
headers that contain the stringBadBot
. You can then configure AWS WAF to reject those requests.To create and configure a
ByteMatchSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateByteMatchSet
request. -
Submit a
CreateByteMatchSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of anUpdateByteMatchSet
request. -
Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
createByteMatchSetRequest
-- Returns:
- A Java Future containing the result of the CreateByteMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafDisallowedNameException The name specified is invalid.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createByteMatchSet
default CompletableFuture<CreateByteMatchSetResponse> createByteMatchSet(Consumer<CreateByteMatchSetRequest.Builder> createByteMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a
ByteMatchSet
. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of theUser-Agent
header or the query string. For example, you can create aByteMatchSet
that matches any requests withUser-Agent
headers that contain the stringBadBot
. You can then configure AWS WAF to reject those requests.To create and configure a
ByteMatchSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateByteMatchSet
request. -
Submit a
CreateByteMatchSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of anUpdateByteMatchSet
request. -
Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateByteMatchSetRequest.Builder
avoiding the need to create one manually viaCreateByteMatchSetRequest.builder()
- Parameters:
createByteMatchSetRequest
- AConsumer
that will call methods onCreateByteMatchSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateByteMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafDisallowedNameException The name specified is invalid.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createGeoMatchSet
default CompletableFuture<CreateGeoMatchSetResponse> createGeoMatchSet(CreateGeoMatchSetRequest createGeoMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an
GeoMatchSet
that contains those countries and then configure AWS WAF to block the requests.To create and configure a
GeoMatchSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateGeoMatchSet
request. -
Submit a
CreateGeoMatchSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateGeoMatchSet request. -
Submit an
UpdateGeoMatchSetSet
request to specify the countries that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
createGeoMatchSetRequest
-- Returns:
- A Java Future containing the result of the CreateGeoMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafDisallowedNameException The name specified is invalid.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createGeoMatchSet
default CompletableFuture<CreateGeoMatchSetResponse> createGeoMatchSet(Consumer<CreateGeoMatchSetRequest.Builder> createGeoMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an
GeoMatchSet
that contains those countries and then configure AWS WAF to block the requests.To create and configure a
GeoMatchSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateGeoMatchSet
request. -
Submit a
CreateGeoMatchSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateGeoMatchSet request. -
Submit an
UpdateGeoMatchSetSet
request to specify the countries that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateGeoMatchSetRequest.Builder
avoiding the need to create one manually viaCreateGeoMatchSetRequest.builder()
- Parameters:
createGeoMatchSetRequest
- AConsumer
that will call methods onCreateGeoMatchSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGeoMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafDisallowedNameException The name specified is invalid.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createIPSet
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an
IPSet
that contains those IP addresses and then configure AWS WAF to block the requests.To create and configure an
IPSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateIPSet
request. -
Submit a
CreateIPSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateIPSet request. -
Submit an
UpdateIPSet
request to specify the IP addresses that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
createIpSetRequest
-- Returns:
- A Java Future containing the result of the CreateIPSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafDisallowedNameException The name specified is invalid.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createIPSet
default CompletableFuture<CreateIpSetResponse> createIPSet(Consumer<CreateIpSetRequest.Builder> createIpSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an
IPSet
that contains those IP addresses and then configure AWS WAF to block the requests.To create and configure an
IPSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateIPSet
request. -
Submit a
CreateIPSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateIPSet request. -
Submit an
UpdateIPSet
request to specify the IP addresses that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateIpSetRequest.Builder
avoiding the need to create one manually viaCreateIpSetRequest.builder()
- Parameters:
createIpSetRequest
- AConsumer
that will call methods onCreateIpSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateIPSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafDisallowedNameException The name specified is invalid.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createRateBasedRule
default CompletableFuture<CreateRateBasedRuleResponse> createRateBasedRule(CreateRateBasedRuleRequest createRateBasedRuleRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a RateBasedRule. The
RateBasedRule
contains aRateLimit
, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. TheRateBasedRule
also contains theIPSet
objects,ByteMatchSet
objects, and other predicates that identify the requests that you want to count or block if these requests exceed theRateLimit
.If you add more than one predicate to a
RateBasedRule
, a request not only must exceed theRateLimit
, but it also must match all the conditions to be counted or blocked. For example, suppose you add the following to aRateBasedRule
:-
An
IPSet
that matches the IP address192.0.2.44/32
-
A
ByteMatchSet
that matchesBadBot
in theUser-Agent
header
Further, you specify a
RateLimit
of 1,000.You then add the
RateBasedRule
to aWebACL
and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and theUser-Agent
header in the request must contain the valueBadBot
. Further, requests that match these two conditions must be received at a rate of more than 1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer blocks the requests.As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a
RateBasedRule
:-
A
ByteMatchSet
withFieldToMatch
ofURI
-
A
PositionalConstraint
ofSTARTS_WITH
-
A
TargetString
oflogin
Further, you specify a
RateLimit
of 1,000.By adding this
RateBasedRule
to aWebACL
, you could limit requests to your login page without affecting the rest of your site.To create and configure a
RateBasedRule
, perform the following steps:-
Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateRule
request. -
Submit a
CreateRateBasedRule
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateRule request. -
Submit an
UpdateRateBasedRule
request to specify the predicates that you want to include in the rule. -
Create and update a
WebACL
that contains theRateBasedRule
. For more information, see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
createRateBasedRuleRequest
-- Returns:
- A Java Future containing the result of the CreateRateBasedRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafDisallowedNameException The name specified is invalid.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafTagOperationException
- WafTagOperationInternalErrorException
- WafBadRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createRateBasedRule
default CompletableFuture<CreateRateBasedRuleResponse> createRateBasedRule(Consumer<CreateRateBasedRuleRequest.Builder> createRateBasedRuleRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a RateBasedRule. The
RateBasedRule
contains aRateLimit
, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. TheRateBasedRule
also contains theIPSet
objects,ByteMatchSet
objects, and other predicates that identify the requests that you want to count or block if these requests exceed theRateLimit
.If you add more than one predicate to a
RateBasedRule
, a request not only must exceed theRateLimit
, but it also must match all the conditions to be counted or blocked. For example, suppose you add the following to aRateBasedRule
:-
An
IPSet
that matches the IP address192.0.2.44/32
-
A
ByteMatchSet
that matchesBadBot
in theUser-Agent
header
Further, you specify a
RateLimit
of 1,000.You then add the
RateBasedRule
to aWebACL
and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and theUser-Agent
header in the request must contain the valueBadBot
. Further, requests that match these two conditions must be received at a rate of more than 1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer blocks the requests.As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a
RateBasedRule
:-
A
ByteMatchSet
withFieldToMatch
ofURI
-
A
PositionalConstraint
ofSTARTS_WITH
-
A
TargetString
oflogin
Further, you specify a
RateLimit
of 1,000.By adding this
RateBasedRule
to aWebACL
, you could limit requests to your login page without affecting the rest of your site.To create and configure a
RateBasedRule
, perform the following steps:-
Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateRule
request. -
Submit a
CreateRateBasedRule
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateRule request. -
Submit an
UpdateRateBasedRule
request to specify the predicates that you want to include in the rule. -
Create and update a
WebACL
that contains theRateBasedRule
. For more information, see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateRateBasedRuleRequest.Builder
avoiding the need to create one manually viaCreateRateBasedRuleRequest.builder()
- Parameters:
createRateBasedRuleRequest
- AConsumer
that will call methods onCreateRateBasedRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRateBasedRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafDisallowedNameException The name specified is invalid.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafTagOperationException
- WafTagOperationInternalErrorException
- WafBadRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createRegexMatchSet
default CompletableFuture<CreateRegexMatchSetResponse> createRegexMatchSet(CreateRegexMatchSetRequest createRegexMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the
User-Agent
header or the query string. For example, you can create aRegexMatchSet
that contains aRegexMatchTuple
that looks for any requests withUser-Agent
headers that match aRegexPatternSet
with patternB[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.To create and configure a
RegexMatchSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateRegexMatchSet
request. -
Submit a
CreateRegexMatchSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of anUpdateRegexMatchSet
request. -
Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a
RegexPatternSet
, that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
createRegexMatchSetRequest
-- Returns:
- A Java Future containing the result of the CreateRegexMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafDisallowedNameException The name specified is invalid.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createRegexMatchSet
default CompletableFuture<CreateRegexMatchSetResponse> createRegexMatchSet(Consumer<CreateRegexMatchSetRequest.Builder> createRegexMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the
User-Agent
header or the query string. For example, you can create aRegexMatchSet
that contains aRegexMatchTuple
that looks for any requests withUser-Agent
headers that match aRegexPatternSet
with patternB[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.To create and configure a
RegexMatchSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateRegexMatchSet
request. -
Submit a
CreateRegexMatchSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of anUpdateRegexMatchSet
request. -
Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a
RegexPatternSet
, that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateRegexMatchSetRequest.Builder
avoiding the need to create one manually viaCreateRegexMatchSetRequest.builder()
- Parameters:
createRegexMatchSetRequest
- AConsumer
that will call methods onCreateRegexMatchSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRegexMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafDisallowedNameException The name specified is invalid.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createRegexPatternSet
default CompletableFuture<CreateRegexPatternSetResponse> createRegexPatternSet(CreateRegexPatternSetRequest createRegexPatternSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a
RegexPatternSet
. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such asB[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.To create and configure a
RegexPatternSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateRegexPatternSet
request. -
Submit a
CreateRegexPatternSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of anUpdateRegexPatternSet
request. -
Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
createRegexPatternSetRequest
-- Returns:
- A Java Future containing the result of the CreateRegexPatternSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafDisallowedNameException The name specified is invalid.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createRegexPatternSet
default CompletableFuture<CreateRegexPatternSetResponse> createRegexPatternSet(Consumer<CreateRegexPatternSetRequest.Builder> createRegexPatternSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a
RegexPatternSet
. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such asB[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.To create and configure a
RegexPatternSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateRegexPatternSet
request. -
Submit a
CreateRegexPatternSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of anUpdateRegexPatternSet
request. -
Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateRegexPatternSetRequest.Builder
avoiding the need to create one manually viaCreateRegexPatternSetRequest.builder()
- Parameters:
createRegexPatternSetRequest
- AConsumer
that will call methods onCreateRegexPatternSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRegexPatternSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafDisallowedNameException The name specified is invalid.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createRule
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a
Rule
, which contains theIPSet
objects,ByteMatchSet
objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to aRule
, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to aRule
:-
An
IPSet
that matches the IP address192.0.2.44/32
-
A
ByteMatchSet
that matchesBadBot
in theUser-Agent
header
You then add the
Rule
to aWebACL
and specify that you want to blocks requests that satisfy theRule
. For a request to be blocked, it must come from the IP address 192.0.2.44 and theUser-Agent
header in the request must contain the valueBadBot
.To create and configure a
Rule
, perform the following steps:-
Create and update the predicates that you want to include in the
Rule
. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateRule
request. -
Submit a
CreateRule
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateRule request. -
Submit an
UpdateRule
request to specify the predicates that you want to include in theRule
. -
Create and update a
WebACL
that contains theRule
. For more information, see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
createRuleRequest
-- Returns:
- A Java Future containing the result of the CreateRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafDisallowedNameException The name specified is invalid.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafTagOperationException
- WafTagOperationInternalErrorException
- WafBadRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createRule
default CompletableFuture<CreateRuleResponse> createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a
Rule
, which contains theIPSet
objects,ByteMatchSet
objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to aRule
, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to aRule
:-
An
IPSet
that matches the IP address192.0.2.44/32
-
A
ByteMatchSet
that matchesBadBot
in theUser-Agent
header
You then add the
Rule
to aWebACL
and specify that you want to blocks requests that satisfy theRule
. For a request to be blocked, it must come from the IP address 192.0.2.44 and theUser-Agent
header in the request must contain the valueBadBot
.To create and configure a
Rule
, perform the following steps:-
Create and update the predicates that you want to include in the
Rule
. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateRule
request. -
Submit a
CreateRule
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateRule request. -
Submit an
UpdateRule
request to specify the predicates that you want to include in theRule
. -
Create and update a
WebACL
that contains theRule
. For more information, see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateRuleRequest.Builder
avoiding the need to create one manually viaCreateRuleRequest.builder()
- Parameters:
createRuleRequest
- AConsumer
that will call methods onCreateRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafDisallowedNameException The name specified is invalid.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafTagOperationException
- WafTagOperationInternalErrorException
- WafBadRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createRuleGroup
default CompletableFuture<CreateRuleGroupResponse> createRuleGroup(CreateRuleGroupRequest createRuleGroupRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a
RuleGroup
. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.Rule groups are subject to the following limits:
-
Three rule groups per account. You can request an increase to this limit by contacting customer support.
-
One rule group per web ACL.
-
Ten rules per rule group.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
createRuleGroupRequest
-- Returns:
- A Java Future containing the result of the CreateRuleGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafDisallowedNameException The name specified is invalid.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafTagOperationException
- WafTagOperationInternalErrorException
- WafBadRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createRuleGroup
default CompletableFuture<CreateRuleGroupResponse> createRuleGroup(Consumer<CreateRuleGroupRequest.Builder> createRuleGroupRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a
RuleGroup
. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.Rule groups are subject to the following limits:
-
Three rule groups per account. You can request an increase to this limit by contacting customer support.
-
One rule group per web ACL.
-
Ten rules per rule group.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateRuleGroupRequest.Builder
avoiding the need to create one manually viaCreateRuleGroupRequest.builder()
- Parameters:
createRuleGroupRequest
- AConsumer
that will call methods onCreateRuleGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRuleGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafDisallowedNameException The name specified is invalid.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafTagOperationException
- WafTagOperationInternalErrorException
- WafBadRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createSizeConstraintSet
default CompletableFuture<CreateSizeConstraintSetResponse> createSizeConstraintSet(CreateSizeConstraintSetRequest createSizeConstraintSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a
SizeConstraintSet
. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of theUser-Agent
header or the length of the query string. For example, you can create aSizeConstraintSet
that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.To create and configure a
SizeConstraintSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateSizeConstraintSet
request. -
Submit a
CreateSizeConstraintSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of anUpdateSizeConstraintSet
request. -
Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
createSizeConstraintSetRequest
-- Returns:
- A Java Future containing the result of the CreateSizeConstraintSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafDisallowedNameException The name specified is invalid.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createSizeConstraintSet
default CompletableFuture<CreateSizeConstraintSetResponse> createSizeConstraintSet(Consumer<CreateSizeConstraintSetRequest.Builder> createSizeConstraintSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a
SizeConstraintSet
. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of theUser-Agent
header or the length of the query string. For example, you can create aSizeConstraintSet
that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.To create and configure a
SizeConstraintSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateSizeConstraintSet
request. -
Submit a
CreateSizeConstraintSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of anUpdateSizeConstraintSet
request. -
Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateSizeConstraintSetRequest.Builder
avoiding the need to create one manually viaCreateSizeConstraintSetRequest.builder()
- Parameters:
createSizeConstraintSetRequest
- AConsumer
that will call methods onCreateSizeConstraintSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSizeConstraintSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafDisallowedNameException The name specified is invalid.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createSqlInjectionMatchSet
default CompletableFuture<CreateSqlInjectionMatchSetResponse> createSqlInjectionMatchSet(CreateSqlInjectionMatchSetRequest createSqlInjectionMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure a
SqlInjectionMatchSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateSqlInjectionMatchSet
request. -
Submit a
CreateSqlInjectionMatchSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateSqlInjectionMatchSet request. -
Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
createSqlInjectionMatchSetRequest
- A request to create a SqlInjectionMatchSet.- Returns:
- A Java Future containing the result of the CreateSqlInjectionMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafDisallowedNameException The name specified is invalid.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createSqlInjectionMatchSet
default CompletableFuture<CreateSqlInjectionMatchSetResponse> createSqlInjectionMatchSet(Consumer<CreateSqlInjectionMatchSetRequest.Builder> createSqlInjectionMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure a
SqlInjectionMatchSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateSqlInjectionMatchSet
request. -
Submit a
CreateSqlInjectionMatchSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateSqlInjectionMatchSet request. -
Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateSqlInjectionMatchSetRequest.Builder
avoiding the need to create one manually viaCreateSqlInjectionMatchSetRequest.builder()
- Parameters:
createSqlInjectionMatchSetRequest
- AConsumer
that will call methods onCreateSqlInjectionMatchSetRequest.Builder
to create a request. A request to create a SqlInjectionMatchSet.- Returns:
- A Java Future containing the result of the CreateSqlInjectionMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafDisallowedNameException The name specified is invalid.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createWebACL
default CompletableFuture<CreateWebAclResponse> createWebACL(CreateWebAclRequest createWebAclRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a
WebACL
, which contains theRules
that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluatesRules
in order based on the value ofPriority
for eachRule
.You also specify a default action, either
ALLOW
orBLOCK
. If a web request doesn't match any of theRules
in aWebACL
, AWS WAF responds to the request with the default action.To create and configure a
WebACL
, perform the following steps:-
Create and update the
ByteMatchSet
objects and other predicates that you want to include inRules
. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. -
Create and update the
Rules
that you want to include in theWebACL
. For more information, see CreateRule and UpdateRule. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateWebACL
request. -
Submit a
CreateWebACL
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateWebACL request. -
Submit an UpdateWebACL request to specify the
Rules
that you want to include in theWebACL
, to specify the default action, and to associate theWebACL
with a CloudFront distribution.
For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
- Parameters:
createWebAclRequest
-- Returns:
- A Java Future containing the result of the CreateWebACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafDisallowedNameException The name specified is invalid.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafTagOperationException
- WafTagOperationInternalErrorException
- WafBadRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createWebACL
default CompletableFuture<CreateWebAclResponse> createWebACL(Consumer<CreateWebAclRequest.Builder> createWebAclRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a
WebACL
, which contains theRules
that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluatesRules
in order based on the value ofPriority
for eachRule
.You also specify a default action, either
ALLOW
orBLOCK
. If a web request doesn't match any of theRules
in aWebACL
, AWS WAF responds to the request with the default action.To create and configure a
WebACL
, perform the following steps:-
Create and update the
ByteMatchSet
objects and other predicates that you want to include inRules
. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. -
Create and update the
Rules
that you want to include in theWebACL
. For more information, see CreateRule and UpdateRule. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateWebACL
request. -
Submit a
CreateWebACL
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateWebACL request. -
Submit an UpdateWebACL request to specify the
Rules
that you want to include in theWebACL
, to specify the default action, and to associate theWebACL
with a CloudFront distribution.
For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateWebAclRequest.Builder
avoiding the need to create one manually viaCreateWebAclRequest.builder()
- Parameters:
createWebAclRequest
- AConsumer
that will call methods onCreateWebAclRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateWebACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafDisallowedNameException The name specified is invalid.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafTagOperationException
- WafTagOperationInternalErrorException
- WafBadRequestException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createWebACLMigrationStack
default CompletableFuture<CreateWebAclMigrationStackResponse> createWebACLMigrationStack(CreateWebAclMigrationStackRequest createWebAclMigrationStackRequest) Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.
This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF Developer Guide.
- Parameters:
createWebAclMigrationStackRequest
-- Returns:
- A Java Future containing the result of the CreateWebACLMigrationStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafEntityMigrationException The operation failed due to a problem with the migration. The failure
cause is provided in the exception, in the
MigrationErrorType
:-
ENTITY_NOT_SUPPORTED
- The web ACL has an unsupported entity but theIgnoreUnsupportedType
is not set to true. -
ENTITY_NOT_FOUND
- The web ACL doesn't exist. -
S3_BUCKET_NO_PERMISSION
- You don't have permission to perform thePutObject
action to the specified Amazon S3 bucket. -
S3_BUCKET_NOT_ACCESSIBLE
- The bucket policy doesn't allow AWS WAF to perform thePutObject
action in the bucket. -
S3_BUCKET_NOT_FOUND
- The S3 bucket doesn't exist. -
S3_BUCKET_INVALID_REGION
- The S3 bucket is not in the same Region as the web ACL. -
S3_INTERNAL_ERROR
- AWS WAF failed to create the template in the S3 bucket for another reason.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWebACLMigrationStack
default CompletableFuture<CreateWebAclMigrationStackResponse> createWebACLMigrationStack(Consumer<CreateWebAclMigrationStackRequest.Builder> createWebAclMigrationStackRequest) Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.
This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateWebAclMigrationStackRequest.Builder
avoiding the need to create one manually viaCreateWebAclMigrationStackRequest.builder()
- Parameters:
createWebAclMigrationStackRequest
- AConsumer
that will call methods onCreateWebAclMigrationStackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateWebACLMigrationStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafEntityMigrationException The operation failed due to a problem with the migration. The failure
cause is provided in the exception, in the
MigrationErrorType
:-
ENTITY_NOT_SUPPORTED
- The web ACL has an unsupported entity but theIgnoreUnsupportedType
is not set to true. -
ENTITY_NOT_FOUND
- The web ACL doesn't exist. -
S3_BUCKET_NO_PERMISSION
- You don't have permission to perform thePutObject
action to the specified Amazon S3 bucket. -
S3_BUCKET_NOT_ACCESSIBLE
- The bucket policy doesn't allow AWS WAF to perform thePutObject
action in the bucket. -
S3_BUCKET_NOT_FOUND
- The S3 bucket doesn't exist. -
S3_BUCKET_INVALID_REGION
- The S3 bucket is not in the same Region as the web ACL. -
S3_INTERNAL_ERROR
- AWS WAF failed to create the template in the S3 bucket for another reason.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createXssMatchSet
default CompletableFuture<CreateXssMatchSetResponse> createXssMatchSet(CreateXssMatchSetRequest createXssMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure an
XssMatchSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateXssMatchSet
request. -
Submit a
CreateXssMatchSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateXssMatchSet request. -
Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
createXssMatchSetRequest
- A request to create an XssMatchSet.- Returns:
- A Java Future containing the result of the CreateXssMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafDisallowedNameException The name specified is invalid.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createXssMatchSet
default CompletableFuture<CreateXssMatchSetResponse> createXssMatchSet(Consumer<CreateXssMatchSetRequest.Builder> createXssMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure an
XssMatchSet
, perform the following steps:-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aCreateXssMatchSet
request. -
Submit a
CreateXssMatchSet
request. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateXssMatchSet request. -
Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
CreateXssMatchSetRequest.Builder
avoiding the need to create one manually viaCreateXssMatchSetRequest.builder()
- Parameters:
createXssMatchSetRequest
- AConsumer
that will call methods onCreateXssMatchSetRequest.Builder
to create a request. A request to create an XssMatchSet.- Returns:
- A Java Future containing the result of the CreateXssMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafDisallowedNameException The name specified is invalid.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteByteMatchSet
default CompletableFuture<DeleteByteMatchSetResponse> deleteByteMatchSet(DeleteByteMatchSetRequest deleteByteMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a ByteMatchSet. You can't delete a
ByteMatchSet
if it's still used in anyRules
or if it still includes any ByteMatchTuple objects (any filters).If you just want to remove a
ByteMatchSet
from aRule
, use UpdateRule.To permanently delete a
ByteMatchSet
, perform the following steps:-
Update the
ByteMatchSet
to remove filters, if any. For more information, see UpdateByteMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteByteMatchSet
request. -
Submit a
DeleteByteMatchSet
request.
- Parameters:
deleteByteMatchSetRequest
-- Returns:
- A Java Future containing the result of the DeleteByteMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteByteMatchSet
default CompletableFuture<DeleteByteMatchSetResponse> deleteByteMatchSet(Consumer<DeleteByteMatchSetRequest.Builder> deleteByteMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a ByteMatchSet. You can't delete a
ByteMatchSet
if it's still used in anyRules
or if it still includes any ByteMatchTuple objects (any filters).If you just want to remove a
ByteMatchSet
from aRule
, use UpdateRule.To permanently delete a
ByteMatchSet
, perform the following steps:-
Update the
ByteMatchSet
to remove filters, if any. For more information, see UpdateByteMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteByteMatchSet
request. -
Submit a
DeleteByteMatchSet
request.
This is a convenience which creates an instance of the
DeleteByteMatchSetRequest.Builder
avoiding the need to create one manually viaDeleteByteMatchSetRequest.builder()
- Parameters:
deleteByteMatchSetRequest
- AConsumer
that will call methods onDeleteByteMatchSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteByteMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteGeoMatchSet
default CompletableFuture<DeleteGeoMatchSetResponse> deleteGeoMatchSet(DeleteGeoMatchSetRequest deleteGeoMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a GeoMatchSet. You can't delete a
GeoMatchSet
if it's still used in anyRules
or if it still includes any countries.If you just want to remove a
GeoMatchSet
from aRule
, use UpdateRule.To permanently delete a
GeoMatchSet
from AWS WAF, perform the following steps:-
Update the
GeoMatchSet
to remove any countries. For more information, see UpdateGeoMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteGeoMatchSet
request. -
Submit a
DeleteGeoMatchSet
request.
- Parameters:
deleteGeoMatchSetRequest
-- Returns:
- A Java Future containing the result of the DeleteGeoMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteGeoMatchSet
default CompletableFuture<DeleteGeoMatchSetResponse> deleteGeoMatchSet(Consumer<DeleteGeoMatchSetRequest.Builder> deleteGeoMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a GeoMatchSet. You can't delete a
GeoMatchSet
if it's still used in anyRules
or if it still includes any countries.If you just want to remove a
GeoMatchSet
from aRule
, use UpdateRule.To permanently delete a
GeoMatchSet
from AWS WAF, perform the following steps:-
Update the
GeoMatchSet
to remove any countries. For more information, see UpdateGeoMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteGeoMatchSet
request. -
Submit a
DeleteGeoMatchSet
request.
This is a convenience which creates an instance of the
DeleteGeoMatchSetRequest.Builder
avoiding the need to create one manually viaDeleteGeoMatchSetRequest.builder()
- Parameters:
deleteGeoMatchSetRequest
- AConsumer
that will call methods onDeleteGeoMatchSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGeoMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteIPSet
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes an IPSet. You can't delete an
IPSet
if it's still used in anyRules
or if it still includes any IP addresses.If you just want to remove an
IPSet
from aRule
, use UpdateRule.To permanently delete an
IPSet
from AWS WAF, perform the following steps:-
Update the
IPSet
to remove IP address ranges, if any. For more information, see UpdateIPSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteIPSet
request. -
Submit a
DeleteIPSet
request.
- Parameters:
deleteIpSetRequest
-- Returns:
- A Java Future containing the result of the DeleteIPSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteIPSet
default CompletableFuture<DeleteIpSetResponse> deleteIPSet(Consumer<DeleteIpSetRequest.Builder> deleteIpSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes an IPSet. You can't delete an
IPSet
if it's still used in anyRules
or if it still includes any IP addresses.If you just want to remove an
IPSet
from aRule
, use UpdateRule.To permanently delete an
IPSet
from AWS WAF, perform the following steps:-
Update the
IPSet
to remove IP address ranges, if any. For more information, see UpdateIPSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteIPSet
request. -
Submit a
DeleteIPSet
request.
This is a convenience which creates an instance of the
DeleteIpSetRequest.Builder
avoiding the need to create one manually viaDeleteIpSetRequest.builder()
- Parameters:
deleteIpSetRequest
- AConsumer
that will call methods onDeleteIpSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteIPSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteLoggingConfiguration
default CompletableFuture<DeleteLoggingConfigurationResponse> deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes the LoggingConfiguration from the specified web ACL.
- Parameters:
deleteLoggingConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLoggingConfiguration
default CompletableFuture<DeleteLoggingConfigurationResponse> deleteLoggingConfiguration(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes the LoggingConfiguration from the specified web ACL.
This is a convenience which creates an instance of the
DeleteLoggingConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteLoggingConfigurationRequest.builder()
- Parameters:
deleteLoggingConfigurationRequest
- AConsumer
that will call methods onDeleteLoggingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePermissionPolicy
default CompletableFuture<DeletePermissionPolicyResponse> deletePermissionPolicy(DeletePermissionPolicyRequest deletePermissionPolicyRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes an IAM policy from the specified RuleGroup.
The user making the request must be the owner of the RuleGroup.
- Parameters:
deletePermissionPolicyRequest
-- Returns:
- A Java Future containing the result of the DeletePermissionPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePermissionPolicy
default CompletableFuture<DeletePermissionPolicyResponse> deletePermissionPolicy(Consumer<DeletePermissionPolicyRequest.Builder> deletePermissionPolicyRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes an IAM policy from the specified RuleGroup.
The user making the request must be the owner of the RuleGroup.
This is a convenience which creates an instance of the
DeletePermissionPolicyRequest.Builder
avoiding the need to create one manually viaDeletePermissionPolicyRequest.builder()
- Parameters:
deletePermissionPolicyRequest
- AConsumer
that will call methods onDeletePermissionPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePermissionPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRateBasedRule
default CompletableFuture<DeleteRateBasedRuleResponse> deleteRateBasedRule(DeleteRateBasedRuleRequest deleteRateBasedRuleRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any
WebACL
objects or if it still includes any predicates, such asByteMatchSet
objects.If you just want to remove a rule from a
WebACL
, use UpdateWebACL.To permanently delete a
RateBasedRule
from AWS WAF, perform the following steps:-
Update the
RateBasedRule
to remove predicates, if any. For more information, see UpdateRateBasedRule. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteRateBasedRule
request. -
Submit a
DeleteRateBasedRule
request.
- Parameters:
deleteRateBasedRuleRequest
-- Returns:
- A Java Future containing the result of the DeleteRateBasedRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteRateBasedRule
default CompletableFuture<DeleteRateBasedRuleResponse> deleteRateBasedRule(Consumer<DeleteRateBasedRuleRequest.Builder> deleteRateBasedRuleRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any
WebACL
objects or if it still includes any predicates, such asByteMatchSet
objects.If you just want to remove a rule from a
WebACL
, use UpdateWebACL.To permanently delete a
RateBasedRule
from AWS WAF, perform the following steps:-
Update the
RateBasedRule
to remove predicates, if any. For more information, see UpdateRateBasedRule. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteRateBasedRule
request. -
Submit a
DeleteRateBasedRule
request.
This is a convenience which creates an instance of the
DeleteRateBasedRuleRequest.Builder
avoiding the need to create one manually viaDeleteRateBasedRuleRequest.builder()
- Parameters:
deleteRateBasedRuleRequest
- AConsumer
that will call methods onDeleteRateBasedRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRateBasedRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteRegexMatchSet
default CompletableFuture<DeleteRegexMatchSetResponse> deleteRegexMatchSet(DeleteRegexMatchSetRequest deleteRegexMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RegexMatchSet. You can't delete a
RegexMatchSet
if it's still used in anyRules
or if it still includes anyRegexMatchTuples
objects (any filters).If you just want to remove a
RegexMatchSet
from aRule
, use UpdateRule.To permanently delete a
RegexMatchSet
, perform the following steps:-
Update the
RegexMatchSet
to remove filters, if any. For more information, see UpdateRegexMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteRegexMatchSet
request. -
Submit a
DeleteRegexMatchSet
request.
- Parameters:
deleteRegexMatchSetRequest
-- Returns:
- A Java Future containing the result of the DeleteRegexMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteRegexMatchSet
default CompletableFuture<DeleteRegexMatchSetResponse> deleteRegexMatchSet(Consumer<DeleteRegexMatchSetRequest.Builder> deleteRegexMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RegexMatchSet. You can't delete a
RegexMatchSet
if it's still used in anyRules
or if it still includes anyRegexMatchTuples
objects (any filters).If you just want to remove a
RegexMatchSet
from aRule
, use UpdateRule.To permanently delete a
RegexMatchSet
, perform the following steps:-
Update the
RegexMatchSet
to remove filters, if any. For more information, see UpdateRegexMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteRegexMatchSet
request. -
Submit a
DeleteRegexMatchSet
request.
This is a convenience which creates an instance of the
DeleteRegexMatchSetRequest.Builder
avoiding the need to create one manually viaDeleteRegexMatchSetRequest.builder()
- Parameters:
deleteRegexMatchSetRequest
- AConsumer
that will call methods onDeleteRegexMatchSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRegexMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteRegexPatternSet
default CompletableFuture<DeleteRegexPatternSetResponse> deleteRegexPatternSet(DeleteRegexPatternSetRequest deleteRegexPatternSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RegexPatternSet. You can't delete a
RegexPatternSet
if it's still used in anyRegexMatchSet
or if theRegexPatternSet
is not empty.- Parameters:
deleteRegexPatternSetRequest
-- Returns:
- A Java Future containing the result of the DeleteRegexPatternSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRegexPatternSet
default CompletableFuture<DeleteRegexPatternSetResponse> deleteRegexPatternSet(Consumer<DeleteRegexPatternSetRequest.Builder> deleteRegexPatternSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RegexPatternSet. You can't delete a
RegexPatternSet
if it's still used in anyRegexMatchSet
or if theRegexPatternSet
is not empty.
This is a convenience which creates an instance of the
DeleteRegexPatternSetRequest.Builder
avoiding the need to create one manually viaDeleteRegexPatternSetRequest.builder()
- Parameters:
deleteRegexPatternSetRequest
- AConsumer
that will call methods onDeleteRegexPatternSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRegexPatternSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRule
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a Rule. You can't delete a
Rule
if it's still used in anyWebACL
objects or if it still includes any predicates, such asByteMatchSet
objects.If you just want to remove a
Rule
from aWebACL
, use UpdateWebACL.To permanently delete a
Rule
from AWS WAF, perform the following steps:-
Update the
Rule
to remove predicates, if any. For more information, see UpdateRule. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteRule
request. -
Submit a
DeleteRule
request.
- Parameters:
deleteRuleRequest
-- Returns:
- A Java Future containing the result of the DeleteRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteRule
default CompletableFuture<DeleteRuleResponse> deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a Rule. You can't delete a
Rule
if it's still used in anyWebACL
objects or if it still includes any predicates, such asByteMatchSet
objects.If you just want to remove a
Rule
from aWebACL
, use UpdateWebACL.To permanently delete a
Rule
from AWS WAF, perform the following steps:-
Update the
Rule
to remove predicates, if any. For more information, see UpdateRule. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteRule
request. -
Submit a
DeleteRule
request.
This is a convenience which creates an instance of the
DeleteRuleRequest.Builder
avoiding the need to create one manually viaDeleteRuleRequest.builder()
- Parameters:
deleteRuleRequest
- AConsumer
that will call methods onDeleteRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteRuleGroup
default CompletableFuture<DeleteRuleGroupResponse> deleteRuleGroup(DeleteRuleGroupRequest deleteRuleGroupRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RuleGroup. You can't delete a
RuleGroup
if it's still used in anyWebACL
objects or if it still includes any rules.If you just want to remove a
RuleGroup
from aWebACL
, use UpdateWebACL.To permanently delete a
RuleGroup
from AWS WAF, perform the following steps:-
Update the
RuleGroup
to remove rules, if any. For more information, see UpdateRuleGroup. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteRuleGroup
request. -
Submit a
DeleteRuleGroup
request.
- Parameters:
deleteRuleGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteRuleGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteRuleGroup
default CompletableFuture<DeleteRuleGroupResponse> deleteRuleGroup(Consumer<DeleteRuleGroupRequest.Builder> deleteRuleGroupRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RuleGroup. You can't delete a
RuleGroup
if it's still used in anyWebACL
objects or if it still includes any rules.If you just want to remove a
RuleGroup
from aWebACL
, use UpdateWebACL.To permanently delete a
RuleGroup
from AWS WAF, perform the following steps:-
Update the
RuleGroup
to remove rules, if any. For more information, see UpdateRuleGroup. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteRuleGroup
request. -
Submit a
DeleteRuleGroup
request.
This is a convenience which creates an instance of the
DeleteRuleGroupRequest.Builder
avoiding the need to create one manually viaDeleteRuleGroupRequest.builder()
- Parameters:
deleteRuleGroupRequest
- AConsumer
that will call methods onDeleteRuleGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRuleGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteSizeConstraintSet
default CompletableFuture<DeleteSizeConstraintSetResponse> deleteSizeConstraintSet(DeleteSizeConstraintSetRequest deleteSizeConstraintSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a SizeConstraintSet. You can't delete a
SizeConstraintSet
if it's still used in anyRules
or if it still includes any SizeConstraint objects (any filters).If you just want to remove a
SizeConstraintSet
from aRule
, use UpdateRule.To permanently delete a
SizeConstraintSet
, perform the following steps:-
Update the
SizeConstraintSet
to remove filters, if any. For more information, see UpdateSizeConstraintSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteSizeConstraintSet
request. -
Submit a
DeleteSizeConstraintSet
request.
- Parameters:
deleteSizeConstraintSetRequest
-- Returns:
- A Java Future containing the result of the DeleteSizeConstraintSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteSizeConstraintSet
default CompletableFuture<DeleteSizeConstraintSetResponse> deleteSizeConstraintSet(Consumer<DeleteSizeConstraintSetRequest.Builder> deleteSizeConstraintSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a SizeConstraintSet. You can't delete a
SizeConstraintSet
if it's still used in anyRules
or if it still includes any SizeConstraint objects (any filters).If you just want to remove a
SizeConstraintSet
from aRule
, use UpdateRule.To permanently delete a
SizeConstraintSet
, perform the following steps:-
Update the
SizeConstraintSet
to remove filters, if any. For more information, see UpdateSizeConstraintSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteSizeConstraintSet
request. -
Submit a
DeleteSizeConstraintSet
request.
This is a convenience which creates an instance of the
DeleteSizeConstraintSetRequest.Builder
avoiding the need to create one manually viaDeleteSizeConstraintSetRequest.builder()
- Parameters:
deleteSizeConstraintSetRequest
- AConsumer
that will call methods onDeleteSizeConstraintSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSizeConstraintSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteSqlInjectionMatchSet
default CompletableFuture<DeleteSqlInjectionMatchSetResponse> deleteSqlInjectionMatchSet(DeleteSqlInjectionMatchSetRequest deleteSqlInjectionMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a SqlInjectionMatchSet. You can't delete a
SqlInjectionMatchSet
if it's still used in anyRules
or if it still contains any SqlInjectionMatchTuple objects.If you just want to remove a
SqlInjectionMatchSet
from aRule
, use UpdateRule.To permanently delete a
SqlInjectionMatchSet
from AWS WAF, perform the following steps:-
Update the
SqlInjectionMatchSet
to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteSqlInjectionMatchSet
request. -
Submit a
DeleteSqlInjectionMatchSet
request.
- Parameters:
deleteSqlInjectionMatchSetRequest
- A request to delete a SqlInjectionMatchSet from AWS WAF.- Returns:
- A Java Future containing the result of the DeleteSqlInjectionMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteSqlInjectionMatchSet
default CompletableFuture<DeleteSqlInjectionMatchSetResponse> deleteSqlInjectionMatchSet(Consumer<DeleteSqlInjectionMatchSetRequest.Builder> deleteSqlInjectionMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a SqlInjectionMatchSet. You can't delete a
SqlInjectionMatchSet
if it's still used in anyRules
or if it still contains any SqlInjectionMatchTuple objects.If you just want to remove a
SqlInjectionMatchSet
from aRule
, use UpdateRule.To permanently delete a
SqlInjectionMatchSet
from AWS WAF, perform the following steps:-
Update the
SqlInjectionMatchSet
to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteSqlInjectionMatchSet
request. -
Submit a
DeleteSqlInjectionMatchSet
request.
This is a convenience which creates an instance of the
DeleteSqlInjectionMatchSetRequest.Builder
avoiding the need to create one manually viaDeleteSqlInjectionMatchSetRequest.builder()
- Parameters:
deleteSqlInjectionMatchSetRequest
- AConsumer
that will call methods onDeleteSqlInjectionMatchSetRequest.Builder
to create a request. A request to delete a SqlInjectionMatchSet from AWS WAF.- Returns:
- A Java Future containing the result of the DeleteSqlInjectionMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteWebACL
default CompletableFuture<DeleteWebAclResponse> deleteWebACL(DeleteWebAclRequest deleteWebAclRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a WebACL. You can't delete a
WebACL
if it still contains anyRules
.To delete a
WebACL
, perform the following steps:-
Update the
WebACL
to removeRules
, if any. For more information, see UpdateWebACL. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteWebACL
request. -
Submit a
DeleteWebACL
request.
- Parameters:
deleteWebAclRequest
-- Returns:
- A Java Future containing the result of the DeleteWebACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteWebACL
default CompletableFuture<DeleteWebAclResponse> deleteWebACL(Consumer<DeleteWebAclRequest.Builder> deleteWebAclRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a WebACL. You can't delete a
WebACL
if it still contains anyRules
.To delete a
WebACL
, perform the following steps:-
Update the
WebACL
to removeRules
, if any. For more information, see UpdateWebACL. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteWebACL
request. -
Submit a
DeleteWebACL
request.
This is a convenience which creates an instance of the
DeleteWebAclRequest.Builder
avoiding the need to create one manually viaDeleteWebAclRequest.builder()
- Parameters:
deleteWebAclRequest
- AConsumer
that will call methods onDeleteWebAclRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteWebACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteXssMatchSet
default CompletableFuture<DeleteXssMatchSetResponse> deleteXssMatchSet(DeleteXssMatchSetRequest deleteXssMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes an XssMatchSet. You can't delete an
XssMatchSet
if it's still used in anyRules
or if it still contains any XssMatchTuple objects.If you just want to remove an
XssMatchSet
from aRule
, use UpdateRule.To permanently delete an
XssMatchSet
from AWS WAF, perform the following steps:-
Update the
XssMatchSet
to remove filters, if any. For more information, see UpdateXssMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteXssMatchSet
request. -
Submit a
DeleteXssMatchSet
request.
- Parameters:
deleteXssMatchSetRequest
- A request to delete an XssMatchSet from AWS WAF.- Returns:
- A Java Future containing the result of the DeleteXssMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteXssMatchSet
default CompletableFuture<DeleteXssMatchSetResponse> deleteXssMatchSet(Consumer<DeleteXssMatchSetRequest.Builder> deleteXssMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes an XssMatchSet. You can't delete an
XssMatchSet
if it's still used in anyRules
or if it still contains any XssMatchTuple objects.If you just want to remove an
XssMatchSet
from aRule
, use UpdateRule.To permanently delete an
XssMatchSet
from AWS WAF, perform the following steps:-
Update the
XssMatchSet
to remove filters, if any. For more information, see UpdateXssMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteXssMatchSet
request. -
Submit a
DeleteXssMatchSet
request.
This is a convenience which creates an instance of the
DeleteXssMatchSetRequest.Builder
avoiding the need to create one manually viaDeleteXssMatchSetRequest.builder()
- Parameters:
deleteXssMatchSetRequest
- AConsumer
that will call methods onDeleteXssMatchSetRequest.Builder
to create a request. A request to delete an XssMatchSet from AWS WAF.- Returns:
- A Java Future containing the result of the DeleteXssMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonEmptyEntityException The operation failed because you tried to delete an object that isn't
empty. For example:
-
You tried to delete a
WebACL
that still contains one or moreRule
objects. -
You tried to delete a
Rule
that still contains one or moreByteMatchSet
objects or other predicates. -
You tried to delete a
ByteMatchSet
that contains one or moreByteMatchTuple
objects. -
You tried to delete an
IPSet
that references one or more IP addresses.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getByteMatchSet
default CompletableFuture<GetByteMatchSetResponse> getByteMatchSet(GetByteMatchSetRequest getByteMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the ByteMatchSet specified by
ByteMatchSetId
.- Parameters:
getByteMatchSetRequest
-- Returns:
- A Java Future containing the result of the GetByteMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getByteMatchSet
default CompletableFuture<GetByteMatchSetResponse> getByteMatchSet(Consumer<GetByteMatchSetRequest.Builder> getByteMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the ByteMatchSet specified by
ByteMatchSetId
.
This is a convenience which creates an instance of the
GetByteMatchSetRequest.Builder
avoiding the need to create one manually viaGetByteMatchSetRequest.builder()
- Parameters:
getByteMatchSetRequest
- AConsumer
that will call methods onGetByteMatchSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetByteMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChangeToken
default CompletableFuture<GetChangeTokenResponse> getChangeToken(GetChangeTokenRequest getChangeTokenRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If your application submits a
GetChangeToken
request and then submits a secondGetChangeToken
request before submitting a create, update, or delete request, the secondGetChangeToken
request returns the same value as the firstGetChangeToken
request.When you use a change token in a create, update, or delete request, the status of the change token changes to
PENDING
, which indicates that AWS WAF is propagating the change to all AWS WAF servers. UseGetChangeTokenStatus
to determine the status of your change token.- Parameters:
getChangeTokenRequest
-- Returns:
- A Java Future containing the result of the GetChangeToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChangeToken
default CompletableFuture<GetChangeTokenResponse> getChangeToken(Consumer<GetChangeTokenRequest.Builder> getChangeTokenRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If your application submits a
GetChangeToken
request and then submits a secondGetChangeToken
request before submitting a create, update, or delete request, the secondGetChangeToken
request returns the same value as the firstGetChangeToken
request.When you use a change token in a create, update, or delete request, the status of the change token changes to
PENDING
, which indicates that AWS WAF is propagating the change to all AWS WAF servers. UseGetChangeTokenStatus
to determine the status of your change token.
This is a convenience which creates an instance of the
GetChangeTokenRequest.Builder
avoiding the need to create one manually viaGetChangeTokenRequest.builder()
- Parameters:
getChangeTokenRequest
- AConsumer
that will call methods onGetChangeTokenRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetChangeToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChangeToken
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If your application submits a
GetChangeToken
request and then submits a secondGetChangeToken
request before submitting a create, update, or delete request, the secondGetChangeToken
request returns the same value as the firstGetChangeToken
request.When you use a change token in a create, update, or delete request, the status of the change token changes to
PENDING
, which indicates that AWS WAF is propagating the change to all AWS WAF servers. UseGetChangeTokenStatus
to determine the status of your change token.- Returns:
- A Java Future containing the result of the GetChangeToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChangeTokenStatus
default CompletableFuture<GetChangeTokenStatusResponse> getChangeTokenStatus(GetChangeTokenStatusRequest getChangeTokenStatusRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the status of a
ChangeToken
that you got by calling GetChangeToken.ChangeTokenStatus
is one of the following values:-
PROVISIONED
: You requested the change token by callingGetChangeToken
, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. -
PENDING
: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. -
INSYNC
: Propagation is complete.
- Parameters:
getChangeTokenStatusRequest
-- Returns:
- A Java Future containing the result of the GetChangeTokenStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getChangeTokenStatus
default CompletableFuture<GetChangeTokenStatusResponse> getChangeTokenStatus(Consumer<GetChangeTokenStatusRequest.Builder> getChangeTokenStatusRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the status of a
ChangeToken
that you got by calling GetChangeToken.ChangeTokenStatus
is one of the following values:-
PROVISIONED
: You requested the change token by callingGetChangeToken
, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. -
PENDING
: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. -
INSYNC
: Propagation is complete.
This is a convenience which creates an instance of the
GetChangeTokenStatusRequest.Builder
avoiding the need to create one manually viaGetChangeTokenStatusRequest.builder()
- Parameters:
getChangeTokenStatusRequest
- AConsumer
that will call methods onGetChangeTokenStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetChangeTokenStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getGeoMatchSet
default CompletableFuture<GetGeoMatchSetResponse> getGeoMatchSet(GetGeoMatchSetRequest getGeoMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the GeoMatchSet that is specified by
GeoMatchSetId
.- Parameters:
getGeoMatchSetRequest
-- Returns:
- A Java Future containing the result of the GetGeoMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGeoMatchSet
default CompletableFuture<GetGeoMatchSetResponse> getGeoMatchSet(Consumer<GetGeoMatchSetRequest.Builder> getGeoMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the GeoMatchSet that is specified by
GeoMatchSetId
.
This is a convenience which creates an instance of the
GetGeoMatchSetRequest.Builder
avoiding the need to create one manually viaGetGeoMatchSetRequest.builder()
- Parameters:
getGeoMatchSetRequest
- AConsumer
that will call methods onGetGeoMatchSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGeoMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIPSet
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the IPSet that is specified by
IPSetId
.- Parameters:
getIpSetRequest
-- Returns:
- A Java Future containing the result of the GetIPSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIPSet
default CompletableFuture<GetIpSetResponse> getIPSet(Consumer<GetIpSetRequest.Builder> getIpSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the IPSet that is specified by
IPSetId
.
This is a convenience which creates an instance of the
GetIpSetRequest.Builder
avoiding the need to create one manually viaGetIpSetRequest.builder()
- Parameters:
getIpSetRequest
- AConsumer
that will call methods onGetIpSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetIPSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLoggingConfiguration
default CompletableFuture<GetLoggingConfigurationResponse> getLoggingConfiguration(GetLoggingConfigurationRequest getLoggingConfigurationRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the LoggingConfiguration for the specified web ACL.
- Parameters:
getLoggingConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLoggingConfiguration
default CompletableFuture<GetLoggingConfigurationResponse> getLoggingConfiguration(Consumer<GetLoggingConfigurationRequest.Builder> getLoggingConfigurationRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the LoggingConfiguration for the specified web ACL.
This is a convenience which creates an instance of the
GetLoggingConfigurationRequest.Builder
avoiding the need to create one manually viaGetLoggingConfigurationRequest.builder()
- Parameters:
getLoggingConfigurationRequest
- AConsumer
that will call methods onGetLoggingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPermissionPolicy
default CompletableFuture<GetPermissionPolicyResponse> getPermissionPolicy(GetPermissionPolicyRequest getPermissionPolicyRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the IAM policy attached to the RuleGroup.
- Parameters:
getPermissionPolicyRequest
-- Returns:
- A Java Future containing the result of the GetPermissionPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPermissionPolicy
default CompletableFuture<GetPermissionPolicyResponse> getPermissionPolicy(Consumer<GetPermissionPolicyRequest.Builder> getPermissionPolicyRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the IAM policy attached to the RuleGroup.
This is a convenience which creates an instance of the
GetPermissionPolicyRequest.Builder
avoiding the need to create one manually viaGetPermissionPolicyRequest.builder()
- Parameters:
getPermissionPolicyRequest
- AConsumer
that will call methods onGetPermissionPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPermissionPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRateBasedRule
default CompletableFuture<GetRateBasedRuleResponse> getRateBasedRule(GetRateBasedRuleRequest getRateBasedRuleRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the RateBasedRule that is specified by the
RuleId
that you included in theGetRateBasedRule
request.- Parameters:
getRateBasedRuleRequest
-- Returns:
- A Java Future containing the result of the GetRateBasedRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRateBasedRule
default CompletableFuture<GetRateBasedRuleResponse> getRateBasedRule(Consumer<GetRateBasedRuleRequest.Builder> getRateBasedRuleRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the RateBasedRule that is specified by the
RuleId
that you included in theGetRateBasedRule
request.
This is a convenience which creates an instance of the
GetRateBasedRuleRequest.Builder
avoiding the need to create one manually viaGetRateBasedRuleRequest.builder()
- Parameters:
getRateBasedRuleRequest
- AConsumer
that will call methods onGetRateBasedRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRateBasedRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRateBasedRuleManagedKeys
default CompletableFuture<GetRateBasedRuleManagedKeysResponse> getRateBasedRuleManagedKeys(GetRateBasedRuleManagedKeysRequest getRateBasedRuleManagedKeysRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the
RuleId
. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.- Parameters:
getRateBasedRuleManagedKeysRequest
-- Returns:
- A Java Future containing the result of the GetRateBasedRuleManagedKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRateBasedRuleManagedKeys
default CompletableFuture<GetRateBasedRuleManagedKeysResponse> getRateBasedRuleManagedKeys(Consumer<GetRateBasedRuleManagedKeysRequest.Builder> getRateBasedRuleManagedKeysRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the
RuleId
. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.
This is a convenience which creates an instance of the
GetRateBasedRuleManagedKeysRequest.Builder
avoiding the need to create one manually viaGetRateBasedRuleManagedKeysRequest.builder()
- Parameters:
getRateBasedRuleManagedKeysRequest
- AConsumer
that will call methods onGetRateBasedRuleManagedKeysRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRateBasedRuleManagedKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRegexMatchSet
default CompletableFuture<GetRegexMatchSetResponse> getRegexMatchSet(GetRegexMatchSetRequest getRegexMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the RegexMatchSet specified by
RegexMatchSetId
.- Parameters:
getRegexMatchSetRequest
-- Returns:
- A Java Future containing the result of the GetRegexMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRegexMatchSet
default CompletableFuture<GetRegexMatchSetResponse> getRegexMatchSet(Consumer<GetRegexMatchSetRequest.Builder> getRegexMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the RegexMatchSet specified by
RegexMatchSetId
.
This is a convenience which creates an instance of the
GetRegexMatchSetRequest.Builder
avoiding the need to create one manually viaGetRegexMatchSetRequest.builder()
- Parameters:
getRegexMatchSetRequest
- AConsumer
that will call methods onGetRegexMatchSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRegexMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRegexPatternSet
default CompletableFuture<GetRegexPatternSetResponse> getRegexPatternSet(GetRegexPatternSetRequest getRegexPatternSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the RegexPatternSet specified by
RegexPatternSetId
.- Parameters:
getRegexPatternSetRequest
-- Returns:
- A Java Future containing the result of the GetRegexPatternSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRegexPatternSet
default CompletableFuture<GetRegexPatternSetResponse> getRegexPatternSet(Consumer<GetRegexPatternSetRequest.Builder> getRegexPatternSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the RegexPatternSet specified by
RegexPatternSetId
.
This is a convenience which creates an instance of the
GetRegexPatternSetRequest.Builder
avoiding the need to create one manually viaGetRegexPatternSetRequest.builder()
- Parameters:
getRegexPatternSetRequest
- AConsumer
that will call methods onGetRegexPatternSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRegexPatternSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRule
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the Rule that is specified by the
RuleId
that you included in theGetRule
request.- Parameters:
getRuleRequest
-- Returns:
- A Java Future containing the result of the GetRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRule
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the Rule that is specified by the
RuleId
that you included in theGetRule
request.
This is a convenience which creates an instance of the
GetRuleRequest.Builder
avoiding the need to create one manually viaGetRuleRequest.builder()
- Parameters:
getRuleRequest
- AConsumer
that will call methods onGetRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRuleGroup
default CompletableFuture<GetRuleGroupResponse> getRuleGroup(GetRuleGroupRequest getRuleGroupRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the RuleGroup that is specified by the
RuleGroupId
that you included in theGetRuleGroup
request.To view the rules in a rule group, use ListActivatedRulesInRuleGroup.
- Parameters:
getRuleGroupRequest
-- Returns:
- A Java Future containing the result of the GetRuleGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRuleGroup
default CompletableFuture<GetRuleGroupResponse> getRuleGroup(Consumer<GetRuleGroupRequest.Builder> getRuleGroupRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the RuleGroup that is specified by the
RuleGroupId
that you included in theGetRuleGroup
request.To view the rules in a rule group, use ListActivatedRulesInRuleGroup.
This is a convenience which creates an instance of the
GetRuleGroupRequest.Builder
avoiding the need to create one manually viaGetRuleGroupRequest.builder()
- Parameters:
getRuleGroupRequest
- AConsumer
that will call methods onGetRuleGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRuleGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSampledRequests
default CompletableFuture<GetSampledRequestsResponse> getSampledRequests(GetSampledRequestsRequest getSampledRequestsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.
GetSampledRequests
returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed,GetSampledRequests
returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.- Parameters:
getSampledRequestsRequest
-- Returns:
- A Java Future containing the result of the GetSampledRequests operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSampledRequests
default CompletableFuture<GetSampledRequestsResponse> getSampledRequests(Consumer<GetSampledRequestsRequest.Builder> getSampledRequestsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.
GetSampledRequests
returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed,GetSampledRequests
returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.
This is a convenience which creates an instance of the
GetSampledRequestsRequest.Builder
avoiding the need to create one manually viaGetSampledRequestsRequest.builder()
- Parameters:
getSampledRequestsRequest
- AConsumer
that will call methods onGetSampledRequestsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSampledRequests operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSizeConstraintSet
default CompletableFuture<GetSizeConstraintSetResponse> getSizeConstraintSet(GetSizeConstraintSetRequest getSizeConstraintSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the SizeConstraintSet specified by
SizeConstraintSetId
.- Parameters:
getSizeConstraintSetRequest
-- Returns:
- A Java Future containing the result of the GetSizeConstraintSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSizeConstraintSet
default CompletableFuture<GetSizeConstraintSetResponse> getSizeConstraintSet(Consumer<GetSizeConstraintSetRequest.Builder> getSizeConstraintSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the SizeConstraintSet specified by
SizeConstraintSetId
.
This is a convenience which creates an instance of the
GetSizeConstraintSetRequest.Builder
avoiding the need to create one manually viaGetSizeConstraintSetRequest.builder()
- Parameters:
getSizeConstraintSetRequest
- AConsumer
that will call methods onGetSizeConstraintSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSizeConstraintSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSqlInjectionMatchSet
default CompletableFuture<GetSqlInjectionMatchSetResponse> getSqlInjectionMatchSet(GetSqlInjectionMatchSetRequest getSqlInjectionMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the SqlInjectionMatchSet that is specified by
SqlInjectionMatchSetId
.- Parameters:
getSqlInjectionMatchSetRequest
- A request to get a SqlInjectionMatchSet.- Returns:
- A Java Future containing the result of the GetSqlInjectionMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSqlInjectionMatchSet
default CompletableFuture<GetSqlInjectionMatchSetResponse> getSqlInjectionMatchSet(Consumer<GetSqlInjectionMatchSetRequest.Builder> getSqlInjectionMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the SqlInjectionMatchSet that is specified by
SqlInjectionMatchSetId
.
This is a convenience which creates an instance of the
GetSqlInjectionMatchSetRequest.Builder
avoiding the need to create one manually viaGetSqlInjectionMatchSetRequest.builder()
- Parameters:
getSqlInjectionMatchSetRequest
- AConsumer
that will call methods onGetSqlInjectionMatchSetRequest.Builder
to create a request. A request to get a SqlInjectionMatchSet.- Returns:
- A Java Future containing the result of the GetSqlInjectionMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWebACL
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the WebACL that is specified by
WebACLId
.- Parameters:
getWebAclRequest
-- Returns:
- A Java Future containing the result of the GetWebACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWebACL
default CompletableFuture<GetWebAclResponse> getWebACL(Consumer<GetWebAclRequest.Builder> getWebAclRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the WebACL that is specified by
WebACLId
.
This is a convenience which creates an instance of the
GetWebAclRequest.Builder
avoiding the need to create one manually viaGetWebAclRequest.builder()
- Parameters:
getWebAclRequest
- AConsumer
that will call methods onGetWebAclRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetWebACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getXssMatchSet
default CompletableFuture<GetXssMatchSetResponse> getXssMatchSet(GetXssMatchSetRequest getXssMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the XssMatchSet that is specified by
XssMatchSetId
.- Parameters:
getXssMatchSetRequest
- A request to get an XssMatchSet.- Returns:
- A Java Future containing the result of the GetXssMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getXssMatchSet
default CompletableFuture<GetXssMatchSetResponse> getXssMatchSet(Consumer<GetXssMatchSetRequest.Builder> getXssMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the XssMatchSet that is specified by
XssMatchSetId
.
This is a convenience which creates an instance of the
GetXssMatchSetRequest.Builder
avoiding the need to create one manually viaGetXssMatchSetRequest.builder()
- Parameters:
getXssMatchSetRequest
- AConsumer
that will call methods onGetXssMatchSetRequest.Builder
to create a request. A request to get an XssMatchSet.- Returns:
- A Java Future containing the result of the GetXssMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActivatedRulesInRuleGroup
default CompletableFuture<ListActivatedRulesInRuleGroupResponse> listActivatedRulesInRuleGroup(ListActivatedRulesInRuleGroupRequest listActivatedRulesInRuleGroupRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of ActivatedRule objects.
- Parameters:
listActivatedRulesInRuleGroupRequest
-- Returns:
- A Java Future containing the result of the ListActivatedRulesInRuleGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActivatedRulesInRuleGroup
default CompletableFuture<ListActivatedRulesInRuleGroupResponse> listActivatedRulesInRuleGroup(Consumer<ListActivatedRulesInRuleGroupRequest.Builder> listActivatedRulesInRuleGroupRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of ActivatedRule objects.
This is a convenience which creates an instance of the
ListActivatedRulesInRuleGroupRequest.Builder
avoiding the need to create one manually viaListActivatedRulesInRuleGroupRequest.builder()
- Parameters:
listActivatedRulesInRuleGroupRequest
- AConsumer
that will call methods onListActivatedRulesInRuleGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListActivatedRulesInRuleGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listByteMatchSets
default CompletableFuture<ListByteMatchSetsResponse> listByteMatchSets(ListByteMatchSetsRequest listByteMatchSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of ByteMatchSetSummary objects.
- Parameters:
listByteMatchSetsRequest
-- Returns:
- A Java Future containing the result of the ListByteMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listByteMatchSets
default CompletableFuture<ListByteMatchSetsResponse> listByteMatchSets(Consumer<ListByteMatchSetsRequest.Builder> listByteMatchSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of ByteMatchSetSummary objects.
This is a convenience which creates an instance of the
ListByteMatchSetsRequest.Builder
avoiding the need to create one manually viaListByteMatchSetsRequest.builder()
- Parameters:
listByteMatchSetsRequest
- AConsumer
that will call methods onListByteMatchSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListByteMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listByteMatchSets
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of ByteMatchSetSummary objects.
- Returns:
- A Java Future containing the result of the ListByteMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeoMatchSets
default CompletableFuture<ListGeoMatchSetsResponse> listGeoMatchSets(ListGeoMatchSetsRequest listGeoMatchSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of GeoMatchSetSummary objects in the response.
- Parameters:
listGeoMatchSetsRequest
-- Returns:
- A Java Future containing the result of the ListGeoMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeoMatchSets
default CompletableFuture<ListGeoMatchSetsResponse> listGeoMatchSets(Consumer<ListGeoMatchSetsRequest.Builder> listGeoMatchSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of GeoMatchSetSummary objects in the response.
This is a convenience which creates an instance of the
ListGeoMatchSetsRequest.Builder
avoiding the need to create one manually viaListGeoMatchSetsRequest.builder()
- Parameters:
listGeoMatchSetsRequest
- AConsumer
that will call methods onListGeoMatchSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGeoMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeoMatchSets
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of GeoMatchSetSummary objects in the response.
- Returns:
- A Java Future containing the result of the ListGeoMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIPSets
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of IPSetSummary objects in the response.
- Parameters:
listIpSetsRequest
-- Returns:
- A Java Future containing the result of the ListIPSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIPSets
default CompletableFuture<ListIpSetsResponse> listIPSets(Consumer<ListIpSetsRequest.Builder> listIpSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of IPSetSummary objects in the response.
This is a convenience which creates an instance of the
ListIpSetsRequest.Builder
avoiding the need to create one manually viaListIpSetsRequest.builder()
- Parameters:
listIpSetsRequest
- AConsumer
that will call methods onListIpSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListIPSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIPSets
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of IPSetSummary objects in the response.
- Returns:
- A Java Future containing the result of the ListIPSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLoggingConfigurations
default CompletableFuture<ListLoggingConfigurationsResponse> listLoggingConfigurations(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of LoggingConfiguration objects.
- Parameters:
listLoggingConfigurationsRequest
-- Returns:
- A Java Future containing the result of the ListLoggingConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLoggingConfigurations
default CompletableFuture<ListLoggingConfigurationsResponse> listLoggingConfigurations(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of LoggingConfiguration objects.
This is a convenience which creates an instance of the
ListLoggingConfigurationsRequest.Builder
avoiding the need to create one manually viaListLoggingConfigurationsRequest.builder()
- Parameters:
listLoggingConfigurationsRequest
- AConsumer
that will call methods onListLoggingConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListLoggingConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRateBasedRules
default CompletableFuture<ListRateBasedRulesResponse> listRateBasedRules(ListRateBasedRulesRequest listRateBasedRulesRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleSummary objects.
- Parameters:
listRateBasedRulesRequest
-- Returns:
- A Java Future containing the result of the ListRateBasedRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRateBasedRules
default CompletableFuture<ListRateBasedRulesResponse> listRateBasedRules(Consumer<ListRateBasedRulesRequest.Builder> listRateBasedRulesRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleSummary objects.
This is a convenience which creates an instance of the
ListRateBasedRulesRequest.Builder
avoiding the need to create one manually viaListRateBasedRulesRequest.builder()
- Parameters:
listRateBasedRulesRequest
- AConsumer
that will call methods onListRateBasedRulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRateBasedRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRateBasedRules
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleSummary objects.
- Returns:
- A Java Future containing the result of the ListRateBasedRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegexMatchSets
default CompletableFuture<ListRegexMatchSetsResponse> listRegexMatchSets(ListRegexMatchSetsRequest listRegexMatchSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RegexMatchSetSummary objects.
- Parameters:
listRegexMatchSetsRequest
-- Returns:
- A Java Future containing the result of the ListRegexMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegexMatchSets
default CompletableFuture<ListRegexMatchSetsResponse> listRegexMatchSets(Consumer<ListRegexMatchSetsRequest.Builder> listRegexMatchSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RegexMatchSetSummary objects.
This is a convenience which creates an instance of the
ListRegexMatchSetsRequest.Builder
avoiding the need to create one manually viaListRegexMatchSetsRequest.builder()
- Parameters:
listRegexMatchSetsRequest
- AConsumer
that will call methods onListRegexMatchSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRegexMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegexMatchSets
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RegexMatchSetSummary objects.
- Returns:
- A Java Future containing the result of the ListRegexMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegexPatternSets
default CompletableFuture<ListRegexPatternSetsResponse> listRegexPatternSets(ListRegexPatternSetsRequest listRegexPatternSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RegexPatternSetSummary objects.
- Parameters:
listRegexPatternSetsRequest
-- Returns:
- A Java Future containing the result of the ListRegexPatternSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegexPatternSets
default CompletableFuture<ListRegexPatternSetsResponse> listRegexPatternSets(Consumer<ListRegexPatternSetsRequest.Builder> listRegexPatternSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RegexPatternSetSummary objects.
This is a convenience which creates an instance of the
ListRegexPatternSetsRequest.Builder
avoiding the need to create one manually viaListRegexPatternSetsRequest.builder()
- Parameters:
listRegexPatternSetsRequest
- AConsumer
that will call methods onListRegexPatternSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRegexPatternSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegexPatternSets
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RegexPatternSetSummary objects.
- Returns:
- A Java Future containing the result of the ListRegexPatternSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleGroups
default CompletableFuture<ListRuleGroupsResponse> listRuleGroups(ListRuleGroupsRequest listRuleGroupsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleGroup objects.
- Parameters:
listRuleGroupsRequest
-- Returns:
- A Java Future containing the result of the ListRuleGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleGroups
default CompletableFuture<ListRuleGroupsResponse> listRuleGroups(Consumer<ListRuleGroupsRequest.Builder> listRuleGroupsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleGroup objects.
This is a convenience which creates an instance of the
ListRuleGroupsRequest.Builder
avoiding the need to create one manually viaListRuleGroupsRequest.builder()
- Parameters:
listRuleGroupsRequest
- AConsumer
that will call methods onListRuleGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRuleGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleGroups
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleGroup objects.
- Returns:
- A Java Future containing the result of the ListRuleGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRules
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleSummary objects.
- Parameters:
listRulesRequest
-- Returns:
- A Java Future containing the result of the ListRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRules
default CompletableFuture<ListRulesResponse> listRules(Consumer<ListRulesRequest.Builder> listRulesRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleSummary objects.
This is a convenience which creates an instance of the
ListRulesRequest.Builder
avoiding the need to create one manually viaListRulesRequest.builder()
- Parameters:
listRulesRequest
- AConsumer
that will call methods onListRulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRules
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleSummary objects.
- Returns:
- A Java Future containing the result of the ListRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSizeConstraintSets
default CompletableFuture<ListSizeConstraintSetsResponse> listSizeConstraintSets(ListSizeConstraintSetsRequest listSizeConstraintSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of SizeConstraintSetSummary objects.
- Parameters:
listSizeConstraintSetsRequest
-- Returns:
- A Java Future containing the result of the ListSizeConstraintSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSizeConstraintSets
default CompletableFuture<ListSizeConstraintSetsResponse> listSizeConstraintSets(Consumer<ListSizeConstraintSetsRequest.Builder> listSizeConstraintSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of SizeConstraintSetSummary objects.
This is a convenience which creates an instance of the
ListSizeConstraintSetsRequest.Builder
avoiding the need to create one manually viaListSizeConstraintSetsRequest.builder()
- Parameters:
listSizeConstraintSetsRequest
- AConsumer
that will call methods onListSizeConstraintSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSizeConstraintSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSizeConstraintSets
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of SizeConstraintSetSummary objects.
- Returns:
- A Java Future containing the result of the ListSizeConstraintSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSqlInjectionMatchSets
default CompletableFuture<ListSqlInjectionMatchSetsResponse> listSqlInjectionMatchSets(ListSqlInjectionMatchSetsRequest listSqlInjectionMatchSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of SqlInjectionMatchSet objects.
- Parameters:
listSqlInjectionMatchSetsRequest
- A request to list the SqlInjectionMatchSet objects created by the current AWS account.- Returns:
- A Java Future containing the result of the ListSqlInjectionMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSqlInjectionMatchSets
default CompletableFuture<ListSqlInjectionMatchSetsResponse> listSqlInjectionMatchSets(Consumer<ListSqlInjectionMatchSetsRequest.Builder> listSqlInjectionMatchSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of SqlInjectionMatchSet objects.
This is a convenience which creates an instance of the
ListSqlInjectionMatchSetsRequest.Builder
avoiding the need to create one manually viaListSqlInjectionMatchSetsRequest.builder()
- Parameters:
listSqlInjectionMatchSetsRequest
- AConsumer
that will call methods onListSqlInjectionMatchSetsRequest.Builder
to create a request. A request to list the SqlInjectionMatchSet objects created by the current AWS account.- Returns:
- A Java Future containing the result of the ListSqlInjectionMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSqlInjectionMatchSets
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of SqlInjectionMatchSet objects.
- Returns:
- A Java Future containing the result of the ListSqlInjectionMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubscribedRuleGroups
default CompletableFuture<ListSubscribedRuleGroupsResponse> listSubscribedRuleGroups(ListSubscribedRuleGroupsRequest listSubscribedRuleGroupsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleGroup objects that you are subscribed to.
- Parameters:
listSubscribedRuleGroupsRequest
-- Returns:
- A Java Future containing the result of the ListSubscribedRuleGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubscribedRuleGroups
default CompletableFuture<ListSubscribedRuleGroupsResponse> listSubscribedRuleGroups(Consumer<ListSubscribedRuleGroupsRequest.Builder> listSubscribedRuleGroupsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleGroup objects that you are subscribed to.
This is a convenience which creates an instance of the
ListSubscribedRuleGroupsRequest.Builder
avoiding the need to create one manually viaListSubscribedRuleGroupsRequest.builder()
- Parameters:
listSubscribedRuleGroupsRequest
- AConsumer
that will call methods onListSubscribedRuleGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSubscribedRuleGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubscribedRuleGroups
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleGroup objects that you are subscribed to.
- Returns:
- A Java Future containing the result of the ListSubscribedRuleGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Retrieves the tags associated with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafBadRequestException
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Retrieves the tags associated with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafBadRequestException
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWebACLs
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of WebACLSummary objects in the response.
- Parameters:
listWebAcLsRequest
-- Returns:
- A Java Future containing the result of the ListWebACLs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWebACLs
default CompletableFuture<ListWebAcLsResponse> listWebACLs(Consumer<ListWebAcLsRequest.Builder> listWebAcLsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of WebACLSummary objects in the response.
This is a convenience which creates an instance of the
ListWebAcLsRequest.Builder
avoiding the need to create one manually viaListWebAcLsRequest.builder()
- Parameters:
listWebAcLsRequest
- AConsumer
that will call methods onListWebAcLsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListWebACLs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWebACLs
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of WebACLSummary objects in the response.
- Returns:
- A Java Future containing the result of the ListWebACLs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listXssMatchSets
default CompletableFuture<ListXssMatchSetsResponse> listXssMatchSets(ListXssMatchSetsRequest listXssMatchSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of XssMatchSet objects.
- Parameters:
listXssMatchSetsRequest
- A request to list the XssMatchSet objects created by the current AWS account.- Returns:
- A Java Future containing the result of the ListXssMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listXssMatchSets
default CompletableFuture<ListXssMatchSetsResponse> listXssMatchSets(Consumer<ListXssMatchSetsRequest.Builder> listXssMatchSetsRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of XssMatchSet objects.
This is a convenience which creates an instance of the
ListXssMatchSetsRequest.Builder
avoiding the need to create one manually viaListXssMatchSetsRequest.builder()
- Parameters:
listXssMatchSetsRequest
- AConsumer
that will call methods onListXssMatchSetsRequest.Builder
to create a request. A request to list the XssMatchSet objects created by the current AWS account.- Returns:
- A Java Future containing the result of the ListXssMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listXssMatchSets
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of XssMatchSet objects.
- Returns:
- A Java Future containing the result of the ListXssMatchSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putLoggingConfiguration
default CompletableFuture<PutLoggingConfigurationResponse> putLoggingConfiguration(PutLoggingConfigurationRequest putLoggingConfigurationRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Associates a LoggingConfiguration with a specified web ACL.
You can access information about all traffic that AWS WAF inspects using the following steps:
-
Create an Amazon Kinesis Data Firehose.
Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).
Do not create the data firehose using a
Kinesis stream
as your source. -
Associate that firehose to your web ACL using a
PutLoggingConfiguration
request.
When you successfully enable logging using a
PutLoggingConfiguration
request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.- Parameters:
putLoggingConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafServiceLinkedRoleErrorException AWS WAF is not able to access the service linked role. This can be
caused by a previous
PutLoggingConfiguration
request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previousDeleteServiceLinkedRole
request, which can lock the role for 15 minutes or more. If you recently made aDeleteServiceLinkedRole
, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
putLoggingConfiguration
default CompletableFuture<PutLoggingConfigurationResponse> putLoggingConfiguration(Consumer<PutLoggingConfigurationRequest.Builder> putLoggingConfigurationRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Associates a LoggingConfiguration with a specified web ACL.
You can access information about all traffic that AWS WAF inspects using the following steps:
-
Create an Amazon Kinesis Data Firehose.
Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).
Do not create the data firehose using a
Kinesis stream
as your source. -
Associate that firehose to your web ACL using a
PutLoggingConfiguration
request.
When you successfully enable logging using a
PutLoggingConfiguration
request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
PutLoggingConfigurationRequest.Builder
avoiding the need to create one manually viaPutLoggingConfigurationRequest.builder()
- Parameters:
putLoggingConfigurationRequest
- AConsumer
that will call methods onPutLoggingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafServiceLinkedRoleErrorException AWS WAF is not able to access the service linked role. This can be
caused by a previous
PutLoggingConfiguration
request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previousDeleteServiceLinkedRole
request, which can lock the role for 15 minutes or more. If you recently made aDeleteServiceLinkedRole
, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
putPermissionPolicy
default CompletableFuture<PutPermissionPolicyResponse> putPermissionPolicy(PutPermissionPolicyRequest putPermissionPolicyRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.
The
PutPermissionPolicy
is subject to the following restrictions:-
You can attach only one policy with each
PutPermissionPolicy
request. -
The policy must include an
Effect
,Action
andPrincipal
. -
Effect
must specifyAllow
. -
The
Action
in the policy must bewaf:UpdateWebACL
,waf-regional:UpdateWebACL
,waf:GetRuleGroup
andwaf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected. -
The policy cannot include a
Resource
parameter. -
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
-
The user making the request must be the owner of the RuleGroup.
-
Your policy must be composed using IAM Policy version 2012-10-17.
For more information, see IAM Policies.
An example of a valid policy parameter is shown in the Examples section below.
- Parameters:
putPermissionPolicyRequest
-- Returns:
- A Java Future containing the result of the PutPermissionPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInvalidPermissionPolicyException The operation failed because the specified policy is not in the
proper format.
The policy is subject to the following restrictions:
-
You can attach only one policy with each
PutPermissionPolicy
request. -
The policy must include an
Effect
,Action
andPrincipal
. -
Effect
must specifyAllow
. -
The
Action
in the policy must bewaf:UpdateWebACL
,waf-regional:UpdateWebACL
,waf:GetRuleGroup
andwaf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected. -
The policy cannot include a
Resource
parameter. -
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
-
The user making the request must be the owner of the RuleGroup.
-
Your policy must be composed using IAM Policy version 2012-10-17.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
putPermissionPolicy
default CompletableFuture<PutPermissionPolicyResponse> putPermissionPolicy(Consumer<PutPermissionPolicyRequest.Builder> putPermissionPolicyRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.
The
PutPermissionPolicy
is subject to the following restrictions:-
You can attach only one policy with each
PutPermissionPolicy
request. -
The policy must include an
Effect
,Action
andPrincipal
. -
Effect
must specifyAllow
. -
The
Action
in the policy must bewaf:UpdateWebACL
,waf-regional:UpdateWebACL
,waf:GetRuleGroup
andwaf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected. -
The policy cannot include a
Resource
parameter. -
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
-
The user making the request must be the owner of the RuleGroup.
-
Your policy must be composed using IAM Policy version 2012-10-17.
For more information, see IAM Policies.
An example of a valid policy parameter is shown in the Examples section below.
This is a convenience which creates an instance of the
PutPermissionPolicyRequest.Builder
avoiding the need to create one manually viaPutPermissionPolicyRequest.builder()
- Parameters:
putPermissionPolicyRequest
- AConsumer
that will call methods onPutPermissionPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutPermissionPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInvalidPermissionPolicyException The operation failed because the specified policy is not in the
proper format.
The policy is subject to the following restrictions:
-
You can attach only one policy with each
PutPermissionPolicy
request. -
The policy must include an
Effect
,Action
andPrincipal
. -
Effect
must specifyAllow
. -
The
Action
in the policy must bewaf:UpdateWebACL
,waf-regional:UpdateWebACL
,waf:GetRuleGroup
andwaf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected. -
The policy cannot include a
Resource
parameter. -
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
-
The user making the request must be the owner of the RuleGroup.
-
Your policy must be composed using IAM Policy version 2012-10-17.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
tagResource
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafBadRequestException
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafBadRequestException
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidParameterException The operation failed because AWS WAF
didn't recognize a parameter in the request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafBadRequestException
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafBadRequestException
- WafTagOperationException
- WafTagOperationInternalErrorException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateByteMatchSet
default CompletableFuture<UpdateByteMatchSetResponse> updateByteMatchSet(UpdateByteMatchSetRequest updateByteMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each
ByteMatchTuple
object, you specify the following values:-
Whether to insert or delete the object from the array. If you want to change a
ByteMatchSetUpdate
object, you delete the existing object and add a new one. -
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
User-Agent
header. -
The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see
TargetString
in the ByteMatchTuple data type. -
Where to look, such as at the beginning or the end of a query string.
-
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can add a
ByteMatchSetUpdate
object that matches web requests in whichUser-Agent
headers contain the stringBadBot
. You can then configure AWS WAF to block those requests.To create and configure a
ByteMatchSet
, perform the following steps:-
Create a
ByteMatchSet.
For more information, see CreateByteMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of anUpdateByteMatchSet
request. -
Submit an
UpdateByteMatchSet
request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
updateByteMatchSetRequest
-- Returns:
- A Java Future containing the result of the UpdateByteMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateByteMatchSet
default CompletableFuture<UpdateByteMatchSetResponse> updateByteMatchSet(Consumer<UpdateByteMatchSetRequest.Builder> updateByteMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each
ByteMatchTuple
object, you specify the following values:-
Whether to insert or delete the object from the array. If you want to change a
ByteMatchSetUpdate
object, you delete the existing object and add a new one. -
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
User-Agent
header. -
The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see
TargetString
in the ByteMatchTuple data type. -
Where to look, such as at the beginning or the end of a query string.
-
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can add a
ByteMatchSetUpdate
object that matches web requests in whichUser-Agent
headers contain the stringBadBot
. You can then configure AWS WAF to block those requests.To create and configure a
ByteMatchSet
, perform the following steps:-
Create a
ByteMatchSet.
For more information, see CreateByteMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of anUpdateByteMatchSet
request. -
Submit an
UpdateByteMatchSet
request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
UpdateByteMatchSetRequest.Builder
avoiding the need to create one manually viaUpdateByteMatchSetRequest.builder()
- Parameters:
updateByteMatchSetRequest
- AConsumer
that will call methods onUpdateByteMatchSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateByteMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateGeoMatchSet
default CompletableFuture<UpdateGeoMatchSetResponse> updateGeoMatchSet(UpdateGeoMatchSetRequest updateGeoMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes GeoMatchConstraint objects in an
GeoMatchSet
. For eachGeoMatchConstraint
object, you specify the following values:-
Whether to insert or delete the object from the array. If you want to change an
GeoMatchConstraint
object, you delete the existing object and add a new one. -
The
Type
. The only valid value forType
isCountry
. -
The
Value
, which is a two character code for the country to add to theGeoMatchConstraint
object. Valid codes are listed in GeoMatchConstraintinvalid input: '$'Value.
To create and configure an
GeoMatchSet
, perform the following steps:-
Submit a CreateGeoMatchSet request.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of an UpdateGeoMatchSet request. -
Submit an
UpdateGeoMatchSet
request to specify the country that you want AWS WAF to watch for.
When you update an
GeoMatchSet
, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
updateGeoMatchSetRequest
-- Returns:
- A Java Future containing the result of the UpdateGeoMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateGeoMatchSet
default CompletableFuture<UpdateGeoMatchSetResponse> updateGeoMatchSet(Consumer<UpdateGeoMatchSetRequest.Builder> updateGeoMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes GeoMatchConstraint objects in an
GeoMatchSet
. For eachGeoMatchConstraint
object, you specify the following values:-
Whether to insert or delete the object from the array. If you want to change an
GeoMatchConstraint
object, you delete the existing object and add a new one. -
The
Type
. The only valid value forType
isCountry
. -
The
Value
, which is a two character code for the country to add to theGeoMatchConstraint
object. Valid codes are listed in GeoMatchConstraintinvalid input: '$'Value.
To create and configure an
GeoMatchSet
, perform the following steps:-
Submit a CreateGeoMatchSet request.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of an UpdateGeoMatchSet request. -
Submit an
UpdateGeoMatchSet
request to specify the country that you want AWS WAF to watch for.
When you update an
GeoMatchSet
, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
UpdateGeoMatchSetRequest.Builder
avoiding the need to create one manually viaUpdateGeoMatchSetRequest.builder()
- Parameters:
updateGeoMatchSetRequest
- AConsumer
that will call methods onUpdateGeoMatchSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGeoMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateIPSet
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes IPSetDescriptor objects in an
IPSet
. For eachIPSetDescriptor
object, you specify the following values:-
Whether to insert or delete the object from the array. If you want to change an
IPSetDescriptor
object, you delete the existing object and add a new one. -
The IP address version,
IPv4
orIPv6
. -
The IP address in CIDR notation, for example,
192.0.2.0/24
(for the range of IP addresses from192.0.2.0
to192.0.2.255
) or192.0.2.44/32
(for the individual IP address192.0.2.44
).
AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
IPv6 addresses can be represented using any of the following formats:
-
1111:0000:0000:0000:0000:0000:0000:0111/128
-
1111:0:0:0:0:0:0:0111/128
-
1111::0111/128
-
1111::111/128
You use an
IPSet
to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create anIPSet
that specifies those IP addresses, and then configure AWS WAF to block the requests.To create and configure an
IPSet
, perform the following steps:-
Submit a CreateIPSet request.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of an UpdateIPSet request. -
Submit an
UpdateIPSet
request to specify the IP addresses that you want AWS WAF to watch for.
When you update an
IPSet
, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.You can insert a maximum of 1000 addresses in a single request.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
updateIpSetRequest
-- Returns:
- A Java Future containing the result of the UpdateIPSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateIPSet
default CompletableFuture<UpdateIpSetResponse> updateIPSet(Consumer<UpdateIpSetRequest.Builder> updateIpSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes IPSetDescriptor objects in an
IPSet
. For eachIPSetDescriptor
object, you specify the following values:-
Whether to insert or delete the object from the array. If you want to change an
IPSetDescriptor
object, you delete the existing object and add a new one. -
The IP address version,
IPv4
orIPv6
. -
The IP address in CIDR notation, for example,
192.0.2.0/24
(for the range of IP addresses from192.0.2.0
to192.0.2.255
) or192.0.2.44/32
(for the individual IP address192.0.2.44
).
AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
IPv6 addresses can be represented using any of the following formats:
-
1111:0000:0000:0000:0000:0000:0000:0111/128
-
1111:0:0:0:0:0:0:0111/128
-
1111::0111/128
-
1111::111/128
You use an
IPSet
to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create anIPSet
that specifies those IP addresses, and then configure AWS WAF to block the requests.To create and configure an
IPSet
, perform the following steps:-
Submit a CreateIPSet request.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of an UpdateIPSet request. -
Submit an
UpdateIPSet
request to specify the IP addresses that you want AWS WAF to watch for.
When you update an
IPSet
, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.You can insert a maximum of 1000 addresses in a single request.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
UpdateIpSetRequest.Builder
avoiding the need to create one manually viaUpdateIpSetRequest.builder()
- Parameters:
updateIpSetRequest
- AConsumer
that will call methods onUpdateIpSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateIPSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateRateBasedRule
default CompletableFuture<UpdateRateBasedRuleResponse> updateRateBasedRule(UpdateRateBasedRuleRequest updateRateBasedRuleRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes Predicate objects in a rule and updates the
RateLimit
in the rule.Each
Predicate
object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. TheRateLimit
specifies the number of requests every five minutes that triggers the rule.If you add more than one predicate to a
RateBasedRule
, a request must match all the predicates and exceed theRateLimit
to be counted or blocked. For example, suppose you add the following to aRateBasedRule
:-
An
IPSet
that matches the IP address192.0.2.44/32
-
A
ByteMatchSet
that matchesBadBot
in theUser-Agent
header
Further, you specify a
RateLimit
of 1,000.You then add the
RateBasedRule
to aWebACL
and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and theUser-Agent
header in the request must contain the valueBadBot
. Further, requests that match these two conditions much be received at a rate of more than 1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests.As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a
RateBasedRule
:-
A
ByteMatchSet
withFieldToMatch
ofURI
-
A
PositionalConstraint
ofSTARTS_WITH
-
A
TargetString
oflogin
Further, you specify a
RateLimit
of 1,000.By adding this
RateBasedRule
to aWebACL
, you could limit requests to your login page without affecting the rest of your site.- Parameters:
updateRateBasedRuleRequest
-- Returns:
- A Java Future containing the result of the UpdateRateBasedRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateRateBasedRule
default CompletableFuture<UpdateRateBasedRuleResponse> updateRateBasedRule(Consumer<UpdateRateBasedRuleRequest.Builder> updateRateBasedRuleRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes Predicate objects in a rule and updates the
RateLimit
in the rule.Each
Predicate
object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. TheRateLimit
specifies the number of requests every five minutes that triggers the rule.If you add more than one predicate to a
RateBasedRule
, a request must match all the predicates and exceed theRateLimit
to be counted or blocked. For example, suppose you add the following to aRateBasedRule
:-
An
IPSet
that matches the IP address192.0.2.44/32
-
A
ByteMatchSet
that matchesBadBot
in theUser-Agent
header
Further, you specify a
RateLimit
of 1,000.You then add the
RateBasedRule
to aWebACL
and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and theUser-Agent
header in the request must contain the valueBadBot
. Further, requests that match these two conditions much be received at a rate of more than 1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests.As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a
RateBasedRule
:-
A
ByteMatchSet
withFieldToMatch
ofURI
-
A
PositionalConstraint
ofSTARTS_WITH
-
A
TargetString
oflogin
Further, you specify a
RateLimit
of 1,000.By adding this
RateBasedRule
to aWebACL
, you could limit requests to your login page without affecting the rest of your site.
This is a convenience which creates an instance of the
UpdateRateBasedRuleRequest.Builder
avoiding the need to create one manually viaUpdateRateBasedRuleRequest.builder()
- Parameters:
updateRateBasedRuleRequest
- AConsumer
that will call methods onUpdateRateBasedRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRateBasedRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateRegexMatchSet
default CompletableFuture<UpdateRegexMatchSetResponse> updateRegexMatchSet(UpdateRegexMatchSetRequest updateRegexMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each
RegexMatchSetUpdate
object, you specify the following values:-
Whether to insert or delete the object from the array. If you want to change a
RegexMatchSetUpdate
object, you delete the existing object and add a new one. -
The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the
User-Agent
header. -
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
-
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can create a
RegexPatternSet
that matches any requests withUser-Agent
headers that contain the stringB[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.To create and configure a
RegexMatchSet
, perform the following steps:-
Create a
RegexMatchSet.
For more information, see CreateRegexMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of anUpdateRegexMatchSet
request. -
Submit an
UpdateRegexMatchSet
request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of theRegexPatternSet
that contain the regular expression patters you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
updateRegexMatchSetRequest
-- Returns:
- A Java Future containing the result of the UpdateRegexMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafDisallowedNameException The name specified is invalid.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateRegexMatchSet
default CompletableFuture<UpdateRegexMatchSetResponse> updateRegexMatchSet(Consumer<UpdateRegexMatchSetRequest.Builder> updateRegexMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each
RegexMatchSetUpdate
object, you specify the following values:-
Whether to insert or delete the object from the array. If you want to change a
RegexMatchSetUpdate
object, you delete the existing object and add a new one. -
The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the
User-Agent
header. -
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
-
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can create a
RegexPatternSet
that matches any requests withUser-Agent
headers that contain the stringB[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.To create and configure a
RegexMatchSet
, perform the following steps:-
Create a
RegexMatchSet.
For more information, see CreateRegexMatchSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of anUpdateRegexMatchSet
request. -
Submit an
UpdateRegexMatchSet
request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of theRegexPatternSet
that contain the regular expression patters you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
UpdateRegexMatchSetRequest.Builder
avoiding the need to create one manually viaUpdateRegexMatchSetRequest.builder()
- Parameters:
updateRegexMatchSetRequest
- AConsumer
that will call methods onUpdateRegexMatchSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRegexMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafDisallowedNameException The name specified is invalid.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateRegexPatternSet
default CompletableFuture<UpdateRegexPatternSetResponse> updateRegexPatternSet(UpdateRegexPatternSetRequest updateRegexPatternSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes
RegexPatternString
objects in a RegexPatternSet. For eachRegexPatternString
object, you specify the following values:-
Whether to insert or delete the
RegexPatternString
. -
The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.
For example, you can create a
RegexPatternString
such asB[a@]dB[o0]t
. AWS WAF will match thisRegexPatternString
to:-
BadBot
-
BadB0t
-
B@dBot
-
B@dB0t
To create and configure a
RegexPatternSet
, perform the following steps:-
Create a
RegexPatternSet.
For more information, see CreateRegexPatternSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of anUpdateRegexPatternSet
request. -
Submit an
UpdateRegexPatternSet
request to specify the regular expression pattern that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
updateRegexPatternSetRequest
-- Returns:
- A Java Future containing the result of the UpdateRegexPatternSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidRegexPatternException The regular expression (regex) you specified in
RegexPatternString
is invalid. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateRegexPatternSet
default CompletableFuture<UpdateRegexPatternSetResponse> updateRegexPatternSet(Consumer<UpdateRegexPatternSetRequest.Builder> updateRegexPatternSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes
RegexPatternString
objects in a RegexPatternSet. For eachRegexPatternString
object, you specify the following values:-
Whether to insert or delete the
RegexPatternString
. -
The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.
For example, you can create a
RegexPatternString
such asB[a@]dB[o0]t
. AWS WAF will match thisRegexPatternString
to:-
BadBot
-
BadB0t
-
B@dBot
-
B@dB0t
To create and configure a
RegexPatternSet
, perform the following steps:-
Create a
RegexPatternSet.
For more information, see CreateRegexPatternSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of anUpdateRegexPatternSet
request. -
Submit an
UpdateRegexPatternSet
request to specify the regular expression pattern that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
UpdateRegexPatternSetRequest.Builder
avoiding the need to create one manually viaUpdateRegexPatternSetRequest.builder()
- Parameters:
updateRegexPatternSetRequest
- AConsumer
that will call methods onUpdateRegexPatternSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRegexPatternSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidRegexPatternException The regular expression (regex) you specified in
RegexPatternString
is invalid. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateRule
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes Predicate objects in a
Rule
. EachPredicate
object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to aRule
, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to aRule
:-
A
ByteMatchSet
that matches the valueBadBot
in theUser-Agent
header -
An
IPSet
that matches the IP address192.0.2.44
You then add the
Rule
to aWebACL
and specify that you want to block requests that satisfy theRule
. For a request to be blocked, theUser-Agent
header in the request must contain the valueBadBot
and the request must originate from the IP address 192.0.2.44.To create and configure a
Rule
, perform the following steps:-
Create and update the predicates that you want to include in the
Rule
. -
Create the
Rule
. See CreateRule. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateRule request. -
Submit an
UpdateRule
request to add predicates to theRule
. -
Create and update a
WebACL
that contains theRule
. See CreateWebACL.
If you want to replace one
ByteMatchSet
orIPSet
with another, you delete the existing one and add the new one.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
updateRuleRequest
-- Returns:
- A Java Future containing the result of the UpdateRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateRule
default CompletableFuture<UpdateRuleResponse> updateRule(Consumer<UpdateRuleRequest.Builder> updateRuleRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes Predicate objects in a
Rule
. EachPredicate
object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to aRule
, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to aRule
:-
A
ByteMatchSet
that matches the valueBadBot
in theUser-Agent
header -
An
IPSet
that matches the IP address192.0.2.44
You then add the
Rule
to aWebACL
and specify that you want to block requests that satisfy theRule
. For a request to be blocked, theUser-Agent
header in the request must contain the valueBadBot
and the request must originate from the IP address 192.0.2.44.To create and configure a
Rule
, perform the following steps:-
Create and update the predicates that you want to include in the
Rule
. -
Create the
Rule
. See CreateRule. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateRule request. -
Submit an
UpdateRule
request to add predicates to theRule
. -
Create and update a
WebACL
that contains theRule
. See CreateWebACL.
If you want to replace one
ByteMatchSet
orIPSet
with another, you delete the existing one and add the new one.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
UpdateRuleRequest.Builder
avoiding the need to create one manually viaUpdateRuleRequest.builder()
- Parameters:
updateRuleRequest
- AConsumer
that will call methods onUpdateRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateRuleGroup
default CompletableFuture<UpdateRuleGroupResponse> updateRuleGroup(UpdateRuleGroupRequest updateRuleGroupRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes ActivatedRule objects in a
RuleGroup
.You can only insert
REGULAR
rules into a rule group.You can have a maximum of ten rules per rule group.
To create and configure a
RuleGroup
, perform the following steps:-
Create and update the
Rules
that you want to include in theRuleGroup
. See CreateRule. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateRuleGroup request. -
Submit an
UpdateRuleGroup
request to addRules
to theRuleGroup
. -
Create and update a
WebACL
that contains theRuleGroup
. See CreateWebACL.
If you want to replace one
Rule
with another, you delete the existing one and add the new one.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
updateRuleGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateRuleGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateRuleGroup
default CompletableFuture<UpdateRuleGroupResponse> updateRuleGroup(Consumer<UpdateRuleGroupRequest.Builder> updateRuleGroupRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes ActivatedRule objects in a
RuleGroup
.You can only insert
REGULAR
rules into a rule group.You can have a maximum of ten rules per rule group.
To create and configure a
RuleGroup
, perform the following steps:-
Create and update the
Rules
that you want to include in theRuleGroup
. See CreateRule. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateRuleGroup request. -
Submit an
UpdateRuleGroup
request to addRules
to theRuleGroup
. -
Create and update a
WebACL
that contains theRuleGroup
. See CreateWebACL.
If you want to replace one
Rule
with another, you delete the existing one and add the new one.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
UpdateRuleGroupRequest.Builder
avoiding the need to create one manually viaUpdateRuleGroupRequest.builder()
- Parameters:
updateRuleGroupRequest
- AConsumer
that will call methods onUpdateRuleGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRuleGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateSizeConstraintSet
default CompletableFuture<UpdateSizeConstraintSetResponse> updateSizeConstraintSet(UpdateSizeConstraintSetRequest updateSizeConstraintSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each
SizeConstraint
object, you specify the following values:-
Whether to insert or delete the object from the array. If you want to change a
SizeConstraintSetUpdate
object, you delete the existing object and add a new one. -
The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the
User-Agent
header. -
Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first
8192
bytes of your request to AWS WAF.You can only specify a single type of TextTransformation.
-
A
ComparisonOperator
used for evaluating the selected part of the request against the specifiedSize
, such as equals, greater than, less than, and so on. -
The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.
For example, you can add a
SizeConstraintSetUpdate
object that matches web requests in which the length of theUser-Agent
header is greater than 100 bytes. You can then configure AWS WAF to block those requests.To create and configure a
SizeConstraintSet
, perform the following steps:-
Create a
SizeConstraintSet.
For more information, see CreateSizeConstraintSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of anUpdateSizeConstraintSet
request. -
Submit an
UpdateSizeConstraintSet
request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
updateSizeConstraintSetRequest
-- Returns:
- A Java Future containing the result of the UpdateSizeConstraintSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateSizeConstraintSet
default CompletableFuture<UpdateSizeConstraintSetResponse> updateSizeConstraintSet(Consumer<UpdateSizeConstraintSetRequest.Builder> updateSizeConstraintSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each
SizeConstraint
object, you specify the following values:-
Whether to insert or delete the object from the array. If you want to change a
SizeConstraintSetUpdate
object, you delete the existing object and add a new one. -
The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the
User-Agent
header. -
Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first
8192
bytes of your request to AWS WAF.You can only specify a single type of TextTransformation.
-
A
ComparisonOperator
used for evaluating the selected part of the request against the specifiedSize
, such as equals, greater than, less than, and so on. -
The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.
For example, you can add a
SizeConstraintSetUpdate
object that matches web requests in which the length of theUser-Agent
header is greater than 100 bytes. You can then configure AWS WAF to block those requests.To create and configure a
SizeConstraintSet
, perform the following steps:-
Create a
SizeConstraintSet.
For more information, see CreateSizeConstraintSet. -
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of anUpdateSizeConstraintSet
request. -
Submit an
UpdateSizeConstraintSet
request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
UpdateSizeConstraintSetRequest.Builder
avoiding the need to create one manually viaUpdateSizeConstraintSetRequest.builder()
- Parameters:
updateSizeConstraintSetRequest
- AConsumer
that will call methods onUpdateSizeConstraintSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSizeConstraintSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateSqlInjectionMatchSet
default CompletableFuture<UpdateSqlInjectionMatchSetResponse> updateSqlInjectionMatchSet(UpdateSqlInjectionMatchSetRequest updateSqlInjectionMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each
SqlInjectionMatchTuple
object, you specify the following values:-
Action
: Whether to insert the object into or delete the object from the array. To change aSqlInjectionMatchTuple
, you delete the existing object and add a new one. -
FieldToMatch
: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. -
TextTransformation
: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.You can only specify a single type of TextTransformation.
You use
SqlInjectionMatchSet
objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create aSqlInjectionMatchSet
with the applicable settings, and then configure AWS WAF to block the requests.To create and configure a
SqlInjectionMatchSet
, perform the following steps:-
Submit a CreateSqlInjectionMatchSet request.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of an UpdateIPSet request. -
Submit an
UpdateSqlInjectionMatchSet
request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
updateSqlInjectionMatchSetRequest
- A request to update a SqlInjectionMatchSet.- Returns:
- A Java Future containing the result of the UpdateSqlInjectionMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateSqlInjectionMatchSet
default CompletableFuture<UpdateSqlInjectionMatchSetResponse> updateSqlInjectionMatchSet(Consumer<UpdateSqlInjectionMatchSetRequest.Builder> updateSqlInjectionMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each
SqlInjectionMatchTuple
object, you specify the following values:-
Action
: Whether to insert the object into or delete the object from the array. To change aSqlInjectionMatchTuple
, you delete the existing object and add a new one. -
FieldToMatch
: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. -
TextTransformation
: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.You can only specify a single type of TextTransformation.
You use
SqlInjectionMatchSet
objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create aSqlInjectionMatchSet
with the applicable settings, and then configure AWS WAF to block the requests.To create and configure a
SqlInjectionMatchSet
, perform the following steps:-
Submit a CreateSqlInjectionMatchSet request.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of an UpdateIPSet request. -
Submit an
UpdateSqlInjectionMatchSet
request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
UpdateSqlInjectionMatchSetRequest.Builder
avoiding the need to create one manually viaUpdateSqlInjectionMatchSetRequest.builder()
- Parameters:
updateSqlInjectionMatchSetRequest
- AConsumer
that will call methods onUpdateSqlInjectionMatchSetRequest.Builder
to create a request. A request to update a SqlInjectionMatchSet.- Returns:
- A Java Future containing the result of the UpdateSqlInjectionMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateWebACL
default CompletableFuture<UpdateWebAclResponse> updateWebACL(UpdateWebAclRequest updateWebAclRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes ActivatedRule objects in a
WebACL
. EachRule
identifies web requests that you want to allow, block, or count. When you update aWebACL
, you specify the following values:-
A default action for the
WebACL
, eitherALLOW
orBLOCK
. AWS WAF performs the default action if a request doesn't match the criteria in any of theRules
in aWebACL
. -
The
Rules
that you want to add or delete. If you want to replace oneRule
with another, you delete the existingRule
and add the new one. -
For each
Rule
, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in theRule
. -
The order in which you want AWS WAF to evaluate the
Rules
in aWebACL
. If you add more than oneRule
to aWebACL
, AWS WAF evaluates each request against theRules
in order based on the value ofPriority
. (TheRule
that has the lowest value forPriority
is evaluated first.) When a web request matches all the predicates (such asByteMatchSets
andIPSets
) in aRule
, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remainingRules
in theWebACL
, if any.
To create and configure a
WebACL
, perform the following steps:-
Create and update the predicates that you want to include in
Rules
. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. -
Create and update the
Rules
that you want to include in theWebACL
. For more information, see CreateRule and UpdateRule. -
Create a
WebACL
. See CreateWebACL. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateWebACL request. -
Submit an
UpdateWebACL
request to specify theRules
that you want to include in theWebACL
, to specify the default action, and to associate theWebACL
with a CloudFront distribution.The
ActivatedRule
can be a rule group. If you specify a rule group as yourActivatedRule
, you can exclude specific rules from that rule group.If you already have a rule group associated with a web ACL and want to submit an
UpdateWebACL
request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRuleinvalid input: '$'ExcludedRules .
Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
updateWebAclRequest
-- Returns:
- A Java Future containing the result of the UpdateWebACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafSubscriptionNotFoundException The specified subscription does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateWebACL
default CompletableFuture<UpdateWebAclResponse> updateWebACL(Consumer<UpdateWebAclRequest.Builder> updateWebAclRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes ActivatedRule objects in a
WebACL
. EachRule
identifies web requests that you want to allow, block, or count. When you update aWebACL
, you specify the following values:-
A default action for the
WebACL
, eitherALLOW
orBLOCK
. AWS WAF performs the default action if a request doesn't match the criteria in any of theRules
in aWebACL
. -
The
Rules
that you want to add or delete. If you want to replace oneRule
with another, you delete the existingRule
and add the new one. -
For each
Rule
, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in theRule
. -
The order in which you want AWS WAF to evaluate the
Rules
in aWebACL
. If you add more than oneRule
to aWebACL
, AWS WAF evaluates each request against theRules
in order based on the value ofPriority
. (TheRule
that has the lowest value forPriority
is evaluated first.) When a web request matches all the predicates (such asByteMatchSets
andIPSets
) in aRule
, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remainingRules
in theWebACL
, if any.
To create and configure a
WebACL
, perform the following steps:-
Create and update the predicates that you want to include in
Rules
. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. -
Create and update the
Rules
that you want to include in theWebACL
. For more information, see CreateRule and UpdateRule. -
Create a
WebACL
. See CreateWebACL. -
Use
GetChangeToken
to get the change token that you provide in theChangeToken
parameter of an UpdateWebACL request. -
Submit an
UpdateWebACL
request to specify theRules
that you want to include in theWebACL
, to specify the default action, and to associate theWebACL
with a CloudFront distribution.The
ActivatedRule
can be a rule group. If you specify a rule group as yourActivatedRule
, you can exclude specific rules from that rule group.If you already have a rule group associated with a web ACL and want to submit an
UpdateWebACL
request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRuleinvalid input: '$'ExcludedRules .
Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
UpdateWebAclRequest.Builder
avoiding the need to create one manually viaUpdateWebAclRequest.builder()
- Parameters:
updateWebAclRequest
- AConsumer
that will call methods onUpdateWebAclRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateWebACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafReferencedItemException The operation failed because you tried to delete an object that is still
in use. For example:
-
You tried to delete a
ByteMatchSet
that is still referenced by aRule
. -
You tried to delete a
Rule
that is still referenced by aWebACL
.
-
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - WafSubscriptionNotFoundException The specified subscription does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateXssMatchSet
default CompletableFuture<UpdateXssMatchSetResponse> updateXssMatchSet(UpdateXssMatchSetRequest updateXssMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each
XssMatchTuple
object, you specify the following values:-
Action
: Whether to insert the object into or delete the object from the array. To change anXssMatchTuple
, you delete the existing object and add a new one. -
FieldToMatch
: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. -
TextTransformation
: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.You can only specify a single type of TextTransformation.
You use
XssMatchSet
objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create anXssMatchSet
with the applicable settings, and then configure AWS WAF to block the requests.To create and configure an
XssMatchSet
, perform the following steps:-
Submit a CreateXssMatchSet request.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of an UpdateIPSet request. -
Submit an
UpdateXssMatchSet
request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
- Parameters:
updateXssMatchSetRequest
- A request to update an XssMatchSet.- Returns:
- A Java Future containing the result of the UpdateXssMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateXssMatchSet
default CompletableFuture<UpdateXssMatchSetResponse> updateXssMatchSet(Consumer<UpdateXssMatchSetRequest.Builder> updateXssMatchSetRequest) This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each
XssMatchTuple
object, you specify the following values:-
Action
: Whether to insert the object into or delete the object from the array. To change anXssMatchTuple
, you delete the existing object and add a new one. -
FieldToMatch
: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. -
TextTransformation
: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.You can only specify a single type of TextTransformation.
You use
XssMatchSet
objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create anXssMatchSet
with the applicable settings, and then configure AWS WAF to block the requests.To create and configure an
XssMatchSet
, perform the following steps:-
Submit a CreateXssMatchSet request.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of an UpdateIPSet request. -
Submit an
UpdateXssMatchSet
request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the
UpdateXssMatchSetRequest.Builder
avoiding the need to create one manually viaUpdateXssMatchSetRequest.builder()
- Parameters:
updateXssMatchSetRequest
- AConsumer
that will call methods onUpdateXssMatchSetRequest.Builder
to create a request. A request to update an XssMatchSet.- Returns:
- A Java Future containing the result of the UpdateXssMatchSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- WafInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- WafInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
- WafInvalidOperationException The operation failed because there was nothing to do. For example:
-
You tried to remove a
Rule
from aWebACL
, but theRule
isn't in the specifiedWebACL
. -
You tried to remove an IP address from an
IPSet
, but the IP address isn't in the specifiedIPSet
. -
You tried to remove a
ByteMatchTuple
from aByteMatchSet
, but theByteMatchTuple
isn't in the specifiedWebACL
. -
You tried to add a
Rule
to aWebACL
, but theRule
already exists in the specifiedWebACL
. -
You tried to add a
ByteMatchTuple
to aByteMatchSet
, but theByteMatchTuple
already exists in the specifiedWebACL
.
-
- WafInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the
request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
- WafNonexistentContainerException The operation failed because you tried to add an object to or delete
an object from another object that doesn't exist. For example:
-
You tried to add a
Rule
to or delete aRule
from aWebACL
that doesn't exist. -
You tried to add a
ByteMatchSet
to or delete aByteMatchSet
from aRule
that doesn't exist. -
You tried to add an IP address to or delete an IP address from an
IPSet
that doesn't exist. -
You tried to add a
ByteMatchTuple
to or delete aByteMatchTuple
from aByteMatchSet
that doesn't exist.
-
- WafNonexistentItemException The operation failed because the referenced object doesn't exist.
- WafStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
- WafLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of
WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WafException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aWafAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aWafAsyncClient
.
-