@Generated(value="software.amazon.awssdk:codegen") public interface WafRegionalClient extends SdkClient
builder()
method.
This is the AWS WAF Regional API Reference for using AWS WAF with Elastic Load Balancing (ELB) Application Load Balancers. The AWS WAF actions and data types listed in the reference are available for protecting Application Load Balancers. You can use these actions and data types by means of the endpoints listed in AWS Regions and Endpoints. This guide is for developers who need detailed information about the AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AssociateWebAclResponse |
associateWebACL(AssociateWebAclRequest associateWebAclRequest)
Associates a web ACL with a resource.
|
default AssociateWebAclResponse |
associateWebACL(Consumer<AssociateWebAclRequest.Builder> associateWebAclRequest)
Associates a web ACL with a resource.
|
static WafRegionalClientBuilder |
builder()
Create a builder that can be used to configure and create a
WafRegionalClient . |
static WafRegionalClient |
create()
Create a
WafRegionalClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateByteMatchSetResponse |
createByteMatchSet(Consumer<CreateByteMatchSetRequest.Builder> createByteMatchSetRequest)
Creates a
ByteMatchSet . |
default CreateByteMatchSetResponse |
createByteMatchSet(CreateByteMatchSetRequest createByteMatchSetRequest)
Creates a
ByteMatchSet . |
default CreateGeoMatchSetResponse |
createGeoMatchSet(Consumer<CreateGeoMatchSetRequest.Builder> createGeoMatchSetRequest)
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.
|
default CreateGeoMatchSetResponse |
createGeoMatchSet(CreateGeoMatchSetRequest createGeoMatchSetRequest)
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.
|
default CreateIpSetResponse |
createIPSet(Consumer<CreateIpSetRequest.Builder> createIpSetRequest)
Creates an IPSet, which you use to specify which web requests you want to allow or block based on the IP
addresses that the requests originate from.
|
default CreateIpSetResponse |
createIPSet(CreateIpSetRequest createIpSetRequest)
Creates an IPSet, which you use to specify which web requests you want to allow or block based on the IP
addresses that the requests originate from.
|
default CreateRateBasedRuleResponse |
createRateBasedRule(Consumer<CreateRateBasedRuleRequest.Builder> createRateBasedRuleRequest)
Creates a RateBasedRule.
|
default CreateRateBasedRuleResponse |
createRateBasedRule(CreateRateBasedRuleRequest createRateBasedRuleRequest)
Creates a RateBasedRule.
|
default CreateRegexMatchSetResponse |
createRegexMatchSet(Consumer<CreateRegexMatchSetRequest.Builder> createRegexMatchSetRequest)
Creates a RegexMatchSet.
|
default CreateRegexMatchSetResponse |
createRegexMatchSet(CreateRegexMatchSetRequest createRegexMatchSetRequest)
Creates a RegexMatchSet.
|
default CreateRegexPatternSetResponse |
createRegexPatternSet(Consumer<CreateRegexPatternSetRequest.Builder> createRegexPatternSetRequest)
Creates a
RegexPatternSet . |
default CreateRegexPatternSetResponse |
createRegexPatternSet(CreateRegexPatternSetRequest createRegexPatternSetRequest)
Creates a
RegexPatternSet . |
default CreateRuleResponse |
createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest)
Creates a
Rule , which contains the IPSet objects, ByteMatchSet objects,
and other predicates that identify the requests that you want to block. |
default CreateRuleResponse |
createRule(CreateRuleRequest createRuleRequest)
Creates a
Rule , which contains the IPSet objects, ByteMatchSet objects,
and other predicates that identify the requests that you want to block. |
default CreateRuleGroupResponse |
createRuleGroup(Consumer<CreateRuleGroupRequest.Builder> createRuleGroupRequest)
Creates a
RuleGroup . |
default CreateRuleGroupResponse |
createRuleGroup(CreateRuleGroupRequest createRuleGroupRequest)
Creates a
RuleGroup . |
default CreateSizeConstraintSetResponse |
createSizeConstraintSet(Consumer<CreateSizeConstraintSetRequest.Builder> createSizeConstraintSetRequest)
Creates a
SizeConstraintSet . |
default CreateSizeConstraintSetResponse |
createSizeConstraintSet(CreateSizeConstraintSetRequest createSizeConstraintSetRequest)
Creates a
SizeConstraintSet . |
default CreateSqlInjectionMatchSetResponse |
createSqlInjectionMatchSet(Consumer<CreateSqlInjectionMatchSetRequest.Builder> createSqlInjectionMatchSetRequest)
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.
|
default CreateSqlInjectionMatchSetResponse |
createSqlInjectionMatchSet(CreateSqlInjectionMatchSetRequest createSqlInjectionMatchSetRequest)
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.
|
default CreateWebAclResponse |
createWebACL(Consumer<CreateWebAclRequest.Builder> createWebAclRequest)
Creates a
WebACL , which contains the Rules that identify the CloudFront web requests
that you want to allow, block, or count. |
default CreateWebAclResponse |
createWebACL(CreateWebAclRequest createWebAclRequest)
Creates a
WebACL , which contains the Rules that identify the CloudFront web requests
that you want to allow, block, or count. |
default CreateXssMatchSetResponse |
createXssMatchSet(Consumer<CreateXssMatchSetRequest.Builder> createXssMatchSetRequest)
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.
|
default CreateXssMatchSetResponse |
createXssMatchSet(CreateXssMatchSetRequest createXssMatchSetRequest)
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.
|
default DeleteByteMatchSetResponse |
deleteByteMatchSet(Consumer<DeleteByteMatchSetRequest.Builder> deleteByteMatchSetRequest)
Permanently deletes a ByteMatchSet.
|
default DeleteByteMatchSetResponse |
deleteByteMatchSet(DeleteByteMatchSetRequest deleteByteMatchSetRequest)
Permanently deletes a ByteMatchSet.
|
default DeleteGeoMatchSetResponse |
deleteGeoMatchSet(Consumer<DeleteGeoMatchSetRequest.Builder> deleteGeoMatchSetRequest)
Permanently deletes a GeoMatchSet.
|
default DeleteGeoMatchSetResponse |
deleteGeoMatchSet(DeleteGeoMatchSetRequest deleteGeoMatchSetRequest)
Permanently deletes a GeoMatchSet.
|
default DeleteIpSetResponse |
deleteIPSet(Consumer<DeleteIpSetRequest.Builder> deleteIpSetRequest)
Permanently deletes an IPSet.
|
default DeleteIpSetResponse |
deleteIPSet(DeleteIpSetRequest deleteIpSetRequest)
Permanently deletes an IPSet.
|
default DeleteLoggingConfigurationResponse |
deleteLoggingConfiguration(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest)
Permanently deletes the LoggingConfiguration from the specified web ACL.
|
default DeleteLoggingConfigurationResponse |
deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest)
Permanently deletes the LoggingConfiguration from the specified web ACL.
|
default DeletePermissionPolicyResponse |
deletePermissionPolicy(Consumer<DeletePermissionPolicyRequest.Builder> deletePermissionPolicyRequest)
Permanently deletes an IAM policy from the specified RuleGroup.
|
default DeletePermissionPolicyResponse |
deletePermissionPolicy(DeletePermissionPolicyRequest deletePermissionPolicyRequest)
Permanently deletes an IAM policy from the specified RuleGroup.
|
default DeleteRateBasedRuleResponse |
deleteRateBasedRule(Consumer<DeleteRateBasedRuleRequest.Builder> deleteRateBasedRuleRequest)
Permanently deletes a RateBasedRule.
|
default DeleteRateBasedRuleResponse |
deleteRateBasedRule(DeleteRateBasedRuleRequest deleteRateBasedRuleRequest)
Permanently deletes a RateBasedRule.
|
default DeleteRegexMatchSetResponse |
deleteRegexMatchSet(Consumer<DeleteRegexMatchSetRequest.Builder> deleteRegexMatchSetRequest)
Permanently deletes a RegexMatchSet.
|
default DeleteRegexMatchSetResponse |
deleteRegexMatchSet(DeleteRegexMatchSetRequest deleteRegexMatchSetRequest)
Permanently deletes a RegexMatchSet.
|
default DeleteRegexPatternSetResponse |
deleteRegexPatternSet(Consumer<DeleteRegexPatternSetRequest.Builder> deleteRegexPatternSetRequest)
Permanently deletes a RegexPatternSet.
|
default DeleteRegexPatternSetResponse |
deleteRegexPatternSet(DeleteRegexPatternSetRequest deleteRegexPatternSetRequest)
Permanently deletes a RegexPatternSet.
|
default DeleteRuleResponse |
deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)
Permanently deletes a Rule.
|
default DeleteRuleResponse |
deleteRule(DeleteRuleRequest deleteRuleRequest)
Permanently deletes a Rule.
|
default DeleteRuleGroupResponse |
deleteRuleGroup(Consumer<DeleteRuleGroupRequest.Builder> deleteRuleGroupRequest)
Permanently deletes a RuleGroup.
|
default DeleteRuleGroupResponse |
deleteRuleGroup(DeleteRuleGroupRequest deleteRuleGroupRequest)
Permanently deletes a RuleGroup.
|
default DeleteSizeConstraintSetResponse |
deleteSizeConstraintSet(Consumer<DeleteSizeConstraintSetRequest.Builder> deleteSizeConstraintSetRequest)
Permanently deletes a SizeConstraintSet.
|
default DeleteSizeConstraintSetResponse |
deleteSizeConstraintSet(DeleteSizeConstraintSetRequest deleteSizeConstraintSetRequest)
Permanently deletes a SizeConstraintSet.
|
default DeleteSqlInjectionMatchSetResponse |
deleteSqlInjectionMatchSet(Consumer<DeleteSqlInjectionMatchSetRequest.Builder> deleteSqlInjectionMatchSetRequest)
Permanently deletes a SqlInjectionMatchSet.
|
default DeleteSqlInjectionMatchSetResponse |
deleteSqlInjectionMatchSet(DeleteSqlInjectionMatchSetRequest deleteSqlInjectionMatchSetRequest)
Permanently deletes a SqlInjectionMatchSet.
|
default DeleteWebAclResponse |
deleteWebACL(Consumer<DeleteWebAclRequest.Builder> deleteWebAclRequest)
Permanently deletes a WebACL.
|
default DeleteWebAclResponse |
deleteWebACL(DeleteWebAclRequest deleteWebAclRequest)
Permanently deletes a WebACL.
|
default DeleteXssMatchSetResponse |
deleteXssMatchSet(Consumer<DeleteXssMatchSetRequest.Builder> deleteXssMatchSetRequest)
Permanently deletes an XssMatchSet.
|
default DeleteXssMatchSetResponse |
deleteXssMatchSet(DeleteXssMatchSetRequest deleteXssMatchSetRequest)
Permanently deletes an XssMatchSet.
|
default DisassociateWebAclResponse |
disassociateWebACL(Consumer<DisassociateWebAclRequest.Builder> disassociateWebAclRequest)
Removes a web ACL from the specified resource.
|
default DisassociateWebAclResponse |
disassociateWebACL(DisassociateWebAclRequest disassociateWebAclRequest)
Removes a web ACL from the specified resource.
|
default GetByteMatchSetResponse |
getByteMatchSet(Consumer<GetByteMatchSetRequest.Builder> getByteMatchSetRequest)
Returns the ByteMatchSet specified by
ByteMatchSetId . |
default GetByteMatchSetResponse |
getByteMatchSet(GetByteMatchSetRequest getByteMatchSetRequest)
Returns the ByteMatchSet specified by
ByteMatchSetId . |
default GetChangeTokenResponse |
getChangeToken()
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.
|
default GetChangeTokenResponse |
getChangeToken(Consumer<GetChangeTokenRequest.Builder> getChangeTokenRequest)
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.
|
default GetChangeTokenResponse |
getChangeToken(GetChangeTokenRequest getChangeTokenRequest)
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.
|
default GetChangeTokenStatusResponse |
getChangeTokenStatus(Consumer<GetChangeTokenStatusRequest.Builder> getChangeTokenStatusRequest)
Returns the status of a
ChangeToken that you got by calling GetChangeToken. |
default GetChangeTokenStatusResponse |
getChangeTokenStatus(GetChangeTokenStatusRequest getChangeTokenStatusRequest)
Returns the status of a
ChangeToken that you got by calling GetChangeToken. |
default GetGeoMatchSetResponse |
getGeoMatchSet(Consumer<GetGeoMatchSetRequest.Builder> getGeoMatchSetRequest)
Returns the GeoMatchSet that is specified by
GeoMatchSetId . |
default GetGeoMatchSetResponse |
getGeoMatchSet(GetGeoMatchSetRequest getGeoMatchSetRequest)
Returns the GeoMatchSet that is specified by
GeoMatchSetId . |
default GetIpSetResponse |
getIPSet(Consumer<GetIpSetRequest.Builder> getIpSetRequest)
Returns the IPSet that is specified by
IPSetId . |
default GetIpSetResponse |
getIPSet(GetIpSetRequest getIpSetRequest)
Returns the IPSet that is specified by
IPSetId . |
default GetLoggingConfigurationResponse |
getLoggingConfiguration(Consumer<GetLoggingConfigurationRequest.Builder> getLoggingConfigurationRequest)
Returns the LoggingConfiguration for the specified web ACL.
|
default GetLoggingConfigurationResponse |
getLoggingConfiguration(GetLoggingConfigurationRequest getLoggingConfigurationRequest)
Returns the LoggingConfiguration for the specified web ACL.
|
default GetPermissionPolicyResponse |
getPermissionPolicy(Consumer<GetPermissionPolicyRequest.Builder> getPermissionPolicyRequest)
Returns the IAM policy attached to the RuleGroup.
|
default GetPermissionPolicyResponse |
getPermissionPolicy(GetPermissionPolicyRequest getPermissionPolicyRequest)
Returns the IAM policy attached to the RuleGroup.
|
default GetRateBasedRuleResponse |
getRateBasedRule(Consumer<GetRateBasedRuleRequest.Builder> getRateBasedRuleRequest)
Returns the RateBasedRule that is specified by the
RuleId that you included in the
GetRateBasedRule request. |
default GetRateBasedRuleResponse |
getRateBasedRule(GetRateBasedRuleRequest getRateBasedRuleRequest)
Returns the RateBasedRule that is specified by the
RuleId that you included in the
GetRateBasedRule request. |
default GetRateBasedRuleManagedKeysResponse |
getRateBasedRuleManagedKeys(Consumer<GetRateBasedRuleManagedKeysRequest.Builder> getRateBasedRuleManagedKeysRequest)
Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the
RuleId . |
default GetRateBasedRuleManagedKeysResponse |
getRateBasedRuleManagedKeys(GetRateBasedRuleManagedKeysRequest getRateBasedRuleManagedKeysRequest)
Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the
RuleId . |
default GetRegexMatchSetResponse |
getRegexMatchSet(Consumer<GetRegexMatchSetRequest.Builder> getRegexMatchSetRequest)
Returns the RegexMatchSet specified by
RegexMatchSetId . |
default GetRegexMatchSetResponse |
getRegexMatchSet(GetRegexMatchSetRequest getRegexMatchSetRequest)
Returns the RegexMatchSet specified by
RegexMatchSetId . |
default GetRegexPatternSetResponse |
getRegexPatternSet(Consumer<GetRegexPatternSetRequest.Builder> getRegexPatternSetRequest)
Returns the RegexPatternSet specified by
RegexPatternSetId . |
default GetRegexPatternSetResponse |
getRegexPatternSet(GetRegexPatternSetRequest getRegexPatternSetRequest)
Returns the RegexPatternSet specified by
RegexPatternSetId . |
default GetRuleResponse |
getRule(Consumer<GetRuleRequest.Builder> getRuleRequest)
|
default GetRuleResponse |
getRule(GetRuleRequest getRuleRequest)
|
default GetRuleGroupResponse |
getRuleGroup(Consumer<GetRuleGroupRequest.Builder> getRuleGroupRequest)
Returns the RuleGroup that is specified by the
RuleGroupId that you included in the
GetRuleGroup request. |
default GetRuleGroupResponse |
getRuleGroup(GetRuleGroupRequest getRuleGroupRequest)
Returns the RuleGroup that is specified by the
RuleGroupId that you included in the
GetRuleGroup request. |
default GetSampledRequestsResponse |
getSampledRequests(Consumer<GetSampledRequestsRequest.Builder> getSampledRequestsRequest)
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.
|
default GetSampledRequestsResponse |
getSampledRequests(GetSampledRequestsRequest getSampledRequestsRequest)
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.
|
default GetSizeConstraintSetResponse |
getSizeConstraintSet(Consumer<GetSizeConstraintSetRequest.Builder> getSizeConstraintSetRequest)
Returns the SizeConstraintSet specified by
SizeConstraintSetId . |
default GetSizeConstraintSetResponse |
getSizeConstraintSet(GetSizeConstraintSetRequest getSizeConstraintSetRequest)
Returns the SizeConstraintSet specified by
SizeConstraintSetId . |
default GetSqlInjectionMatchSetResponse |
getSqlInjectionMatchSet(Consumer<GetSqlInjectionMatchSetRequest.Builder> getSqlInjectionMatchSetRequest)
Returns the SqlInjectionMatchSet that is specified by
SqlInjectionMatchSetId . |
default GetSqlInjectionMatchSetResponse |
getSqlInjectionMatchSet(GetSqlInjectionMatchSetRequest getSqlInjectionMatchSetRequest)
Returns the SqlInjectionMatchSet that is specified by
SqlInjectionMatchSetId . |
default GetWebAclResponse |
getWebACL(Consumer<GetWebAclRequest.Builder> getWebAclRequest)
Returns the WebACL that is specified by
WebACLId . |
default GetWebAclResponse |
getWebACL(GetWebAclRequest getWebAclRequest)
Returns the WebACL that is specified by
WebACLId . |
default GetWebAclForResourceResponse |
getWebACLForResource(Consumer<GetWebAclForResourceRequest.Builder> getWebAclForResourceRequest)
Returns the web ACL for the specified resource.
|
default GetWebAclForResourceResponse |
getWebACLForResource(GetWebAclForResourceRequest getWebAclForResourceRequest)
Returns the web ACL for the specified resource.
|
default GetXssMatchSetResponse |
getXssMatchSet(Consumer<GetXssMatchSetRequest.Builder> getXssMatchSetRequest)
Returns the XssMatchSet that is specified by
XssMatchSetId . |
default GetXssMatchSetResponse |
getXssMatchSet(GetXssMatchSetRequest getXssMatchSetRequest)
Returns the XssMatchSet that is specified by
XssMatchSetId . |
default ListActivatedRulesInRuleGroupResponse |
listActivatedRulesInRuleGroup(Consumer<ListActivatedRulesInRuleGroupRequest.Builder> listActivatedRulesInRuleGroupRequest)
Returns an array of ActivatedRule objects.
|
default ListActivatedRulesInRuleGroupResponse |
listActivatedRulesInRuleGroup(ListActivatedRulesInRuleGroupRequest listActivatedRulesInRuleGroupRequest)
Returns an array of ActivatedRule objects.
|
default ListByteMatchSetsResponse |
listByteMatchSets()
Returns an array of ByteMatchSetSummary objects.
|
default ListByteMatchSetsResponse |
listByteMatchSets(Consumer<ListByteMatchSetsRequest.Builder> listByteMatchSetsRequest)
Returns an array of ByteMatchSetSummary objects.
|
default ListByteMatchSetsResponse |
listByteMatchSets(ListByteMatchSetsRequest listByteMatchSetsRequest)
Returns an array of ByteMatchSetSummary objects.
|
default ListGeoMatchSetsResponse |
listGeoMatchSets()
Returns an array of GeoMatchSetSummary objects in the response.
|
default ListGeoMatchSetsResponse |
listGeoMatchSets(Consumer<ListGeoMatchSetsRequest.Builder> listGeoMatchSetsRequest)
Returns an array of GeoMatchSetSummary objects in the response.
|
default ListGeoMatchSetsResponse |
listGeoMatchSets(ListGeoMatchSetsRequest listGeoMatchSetsRequest)
Returns an array of GeoMatchSetSummary objects in the response.
|
default ListIpSetsResponse |
listIPSets()
Returns an array of IPSetSummary objects in the response.
|
default ListIpSetsResponse |
listIPSets(Consumer<ListIpSetsRequest.Builder> listIpSetsRequest)
Returns an array of IPSetSummary objects in the response.
|
default ListIpSetsResponse |
listIPSets(ListIpSetsRequest listIpSetsRequest)
Returns an array of IPSetSummary objects in the response.
|
default ListLoggingConfigurationsResponse |
listLoggingConfigurations(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest)
Returns an array of LoggingConfiguration objects.
|
default ListLoggingConfigurationsResponse |
listLoggingConfigurations(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest)
Returns an array of LoggingConfiguration objects.
|
default ListRateBasedRulesResponse |
listRateBasedRules()
Returns an array of RuleSummary objects.
|
default ListRateBasedRulesResponse |
listRateBasedRules(Consumer<ListRateBasedRulesRequest.Builder> listRateBasedRulesRequest)
Returns an array of RuleSummary objects.
|
default ListRateBasedRulesResponse |
listRateBasedRules(ListRateBasedRulesRequest listRateBasedRulesRequest)
Returns an array of RuleSummary objects.
|
default ListRegexMatchSetsResponse |
listRegexMatchSets()
Returns an array of RegexMatchSetSummary objects.
|
default ListRegexMatchSetsResponse |
listRegexMatchSets(Consumer<ListRegexMatchSetsRequest.Builder> listRegexMatchSetsRequest)
Returns an array of RegexMatchSetSummary objects.
|
default ListRegexMatchSetsResponse |
listRegexMatchSets(ListRegexMatchSetsRequest listRegexMatchSetsRequest)
Returns an array of RegexMatchSetSummary objects.
|
default ListRegexPatternSetsResponse |
listRegexPatternSets()
Returns an array of RegexPatternSetSummary objects.
|
default ListRegexPatternSetsResponse |
listRegexPatternSets(Consumer<ListRegexPatternSetsRequest.Builder> listRegexPatternSetsRequest)
Returns an array of RegexPatternSetSummary objects.
|
default ListRegexPatternSetsResponse |
listRegexPatternSets(ListRegexPatternSetsRequest listRegexPatternSetsRequest)
Returns an array of RegexPatternSetSummary objects.
|
default ListResourcesForWebAclResponse |
listResourcesForWebACL(Consumer<ListResourcesForWebAclRequest.Builder> listResourcesForWebAclRequest)
Returns an array of resources associated with the specified web ACL.
|
default ListResourcesForWebAclResponse |
listResourcesForWebACL(ListResourcesForWebAclRequest listResourcesForWebAclRequest)
Returns an array of resources associated with the specified web ACL.
|
default ListRuleGroupsResponse |
listRuleGroups()
Returns an array of RuleGroup objects.
|
default ListRuleGroupsResponse |
listRuleGroups(Consumer<ListRuleGroupsRequest.Builder> listRuleGroupsRequest)
Returns an array of RuleGroup objects.
|
default ListRuleGroupsResponse |
listRuleGroups(ListRuleGroupsRequest listRuleGroupsRequest)
Returns an array of RuleGroup objects.
|
default ListRulesResponse |
listRules()
Returns an array of RuleSummary objects.
|
default ListRulesResponse |
listRules(Consumer<ListRulesRequest.Builder> listRulesRequest)
Returns an array of RuleSummary objects.
|
default ListRulesResponse |
listRules(ListRulesRequest listRulesRequest)
Returns an array of RuleSummary objects.
|
default ListSizeConstraintSetsResponse |
listSizeConstraintSets()
Returns an array of SizeConstraintSetSummary objects.
|
default ListSizeConstraintSetsResponse |
listSizeConstraintSets(Consumer<ListSizeConstraintSetsRequest.Builder> listSizeConstraintSetsRequest)
Returns an array of SizeConstraintSetSummary objects.
|
default ListSizeConstraintSetsResponse |
listSizeConstraintSets(ListSizeConstraintSetsRequest listSizeConstraintSetsRequest)
Returns an array of SizeConstraintSetSummary objects.
|
default ListSqlInjectionMatchSetsResponse |
listSqlInjectionMatchSets()
Returns an array of SqlInjectionMatchSet objects.
|
default ListSqlInjectionMatchSetsResponse |
listSqlInjectionMatchSets(Consumer<ListSqlInjectionMatchSetsRequest.Builder> listSqlInjectionMatchSetsRequest)
Returns an array of SqlInjectionMatchSet objects.
|
default ListSqlInjectionMatchSetsResponse |
listSqlInjectionMatchSets(ListSqlInjectionMatchSetsRequest listSqlInjectionMatchSetsRequest)
Returns an array of SqlInjectionMatchSet objects.
|
default ListSubscribedRuleGroupsResponse |
listSubscribedRuleGroups()
Returns an array of RuleGroup objects that you are subscribed to.
|
default ListSubscribedRuleGroupsResponse |
listSubscribedRuleGroups(Consumer<ListSubscribedRuleGroupsRequest.Builder> listSubscribedRuleGroupsRequest)
Returns an array of RuleGroup objects that you are subscribed to.
|
default ListSubscribedRuleGroupsResponse |
listSubscribedRuleGroups(ListSubscribedRuleGroupsRequest listSubscribedRuleGroupsRequest)
Returns an array of RuleGroup objects that you are subscribed to.
|
default ListWebAcLsResponse |
listWebACLs()
Returns an array of WebACLSummary objects in the response.
|
default ListWebAcLsResponse |
listWebACLs(Consumer<ListWebAcLsRequest.Builder> listWebAcLsRequest)
Returns an array of WebACLSummary objects in the response.
|
default ListWebAcLsResponse |
listWebACLs(ListWebAcLsRequest listWebAcLsRequest)
Returns an array of WebACLSummary objects in the response.
|
default ListXssMatchSetsResponse |
listXssMatchSets()
Returns an array of XssMatchSet objects.
|
default ListXssMatchSetsResponse |
listXssMatchSets(Consumer<ListXssMatchSetsRequest.Builder> listXssMatchSetsRequest)
Returns an array of XssMatchSet objects.
|
default ListXssMatchSetsResponse |
listXssMatchSets(ListXssMatchSetsRequest listXssMatchSetsRequest)
Returns an array of XssMatchSet objects.
|
default PutLoggingConfigurationResponse |
putLoggingConfiguration(Consumer<PutLoggingConfigurationRequest.Builder> putLoggingConfigurationRequest)
Associates a LoggingConfiguration with a specified web ACL.
|
default PutLoggingConfigurationResponse |
putLoggingConfiguration(PutLoggingConfigurationRequest putLoggingConfigurationRequest)
Associates a LoggingConfiguration with a specified web ACL.
|
default PutPermissionPolicyResponse |
putPermissionPolicy(Consumer<PutPermissionPolicyRequest.Builder> putPermissionPolicyRequest)
Attaches a IAM policy to the specified resource.
|
default PutPermissionPolicyResponse |
putPermissionPolicy(PutPermissionPolicyRequest putPermissionPolicyRequest)
Attaches a IAM policy to the specified resource.
|
static ServiceMetadata |
serviceMetadata() |
default UpdateByteMatchSetResponse |
updateByteMatchSet(Consumer<UpdateByteMatchSetRequest.Builder> updateByteMatchSetRequest)
Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet.
|
default UpdateByteMatchSetResponse |
updateByteMatchSet(UpdateByteMatchSetRequest updateByteMatchSetRequest)
Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet.
|
default UpdateGeoMatchSetResponse |
updateGeoMatchSet(Consumer<UpdateGeoMatchSetRequest.Builder> updateGeoMatchSetRequest)
Inserts or deletes GeoMatchConstraint objects in an
GeoMatchSet . |
default UpdateGeoMatchSetResponse |
updateGeoMatchSet(UpdateGeoMatchSetRequest updateGeoMatchSetRequest)
Inserts or deletes GeoMatchConstraint objects in an
GeoMatchSet . |
default UpdateIpSetResponse |
updateIPSet(Consumer<UpdateIpSetRequest.Builder> updateIpSetRequest)
Inserts or deletes IPSetDescriptor objects in an
IPSet . |
default UpdateIpSetResponse |
updateIPSet(UpdateIpSetRequest updateIpSetRequest)
Inserts or deletes IPSetDescriptor objects in an
IPSet . |
default UpdateRateBasedRuleResponse |
updateRateBasedRule(Consumer<UpdateRateBasedRuleRequest.Builder> updateRateBasedRuleRequest)
Inserts or deletes Predicate objects in a rule and updates the
RateLimit in the rule. |
default UpdateRateBasedRuleResponse |
updateRateBasedRule(UpdateRateBasedRuleRequest updateRateBasedRuleRequest)
Inserts or deletes Predicate objects in a rule and updates the
RateLimit in the rule. |
default UpdateRegexMatchSetResponse |
updateRegexMatchSet(Consumer<UpdateRegexMatchSetRequest.Builder> updateRegexMatchSetRequest)
Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet.
|
default UpdateRegexMatchSetResponse |
updateRegexMatchSet(UpdateRegexMatchSetRequest updateRegexMatchSetRequest)
Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet.
|
default UpdateRegexPatternSetResponse |
updateRegexPatternSet(Consumer<UpdateRegexPatternSetRequest.Builder> updateRegexPatternSetRequest)
Inserts or deletes
RegexPatternString objects in a RegexPatternSet. |
default UpdateRegexPatternSetResponse |
updateRegexPatternSet(UpdateRegexPatternSetRequest updateRegexPatternSetRequest)
Inserts or deletes
RegexPatternString objects in a RegexPatternSet. |
default UpdateRuleResponse |
updateRule(Consumer<UpdateRuleRequest.Builder> updateRuleRequest)
Inserts or deletes Predicate objects in a
Rule . |
default UpdateRuleResponse |
updateRule(UpdateRuleRequest updateRuleRequest)
Inserts or deletes Predicate objects in a
Rule . |
default UpdateRuleGroupResponse |
updateRuleGroup(Consumer<UpdateRuleGroupRequest.Builder> updateRuleGroupRequest)
Inserts or deletes ActivatedRule objects in a
RuleGroup . |
default UpdateRuleGroupResponse |
updateRuleGroup(UpdateRuleGroupRequest updateRuleGroupRequest)
Inserts or deletes ActivatedRule objects in a
RuleGroup . |
default UpdateSizeConstraintSetResponse |
updateSizeConstraintSet(Consumer<UpdateSizeConstraintSetRequest.Builder> updateSizeConstraintSetRequest)
Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet.
|
default UpdateSizeConstraintSetResponse |
updateSizeConstraintSet(UpdateSizeConstraintSetRequest updateSizeConstraintSetRequest)
Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet.
|
default UpdateSqlInjectionMatchSetResponse |
updateSqlInjectionMatchSet(Consumer<UpdateSqlInjectionMatchSetRequest.Builder> updateSqlInjectionMatchSetRequest)
Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet.
|
default UpdateSqlInjectionMatchSetResponse |
updateSqlInjectionMatchSet(UpdateSqlInjectionMatchSetRequest updateSqlInjectionMatchSetRequest)
Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet.
|
default UpdateWebAclResponse |
updateWebACL(Consumer<UpdateWebAclRequest.Builder> updateWebAclRequest)
Inserts or deletes ActivatedRule objects in a
WebACL . |
default UpdateWebAclResponse |
updateWebACL(UpdateWebAclRequest updateWebAclRequest)
Inserts or deletes ActivatedRule objects in a
WebACL . |
default UpdateXssMatchSetResponse |
updateXssMatchSet(Consumer<UpdateXssMatchSetRequest.Builder> updateXssMatchSetRequest)
Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet.
|
default UpdateXssMatchSetResponse |
updateXssMatchSet(UpdateXssMatchSetRequest updateXssMatchSetRequest)
Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet.
|
serviceName
close
static final String SERVICE_NAME
static WafRegionalClient create()
WafRegionalClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static WafRegionalClientBuilder builder()
WafRegionalClient
.default AssociateWebAclResponse associateWebACL(AssociateWebAclRequest associateWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafNonexistentItemException, WafUnavailableEntityException, AwsServiceException, SdkClientException, WafException
Associates a web ACL with a resource.
associateWebAclRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafUnavailableEntityException
- The operation failed because the entity referenced is temporarily unavailable. 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default AssociateWebAclResponse associateWebACL(Consumer<AssociateWebAclRequest.Builder> associateWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafNonexistentItemException, WafUnavailableEntityException, AwsServiceException, SdkClientException, WafException
Associates a web ACL with a resource.
This is a convenience which creates an instance of the AssociateWebAclRequest.Builder
avoiding the need
to create one manually via AssociateWebAclRequest.builder()
associateWebAclRequest
- A Consumer
that will call methods on AssociateWebACLRequest.Builder
to create a request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafUnavailableEntityException
- The operation failed because the entity referenced is temporarily unavailable. 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateByteMatchSetResponse createByteMatchSet(CreateByteMatchSetRequest createByteMatchSetRequest) throws WafDisallowedNameException, WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a ByteMatchSet
. You then use UpdateByteMatchSet to identify the part of a web request
that you want AWS WAF to inspect, such as the values of the User-Agent
header or the query string.
For example, you can create a ByteMatchSet
that matches any requests with User-Agent
headers that contain the string BadBot
. You can then configure AWS WAF to reject those requests.
To create and configure a ByteMatchSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateByteMatchSet
request.
Submit a CreateByteMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateByteMatchSet
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.
createByteMatchSetRequest
- WafDisallowedNameException
- The name specified is invalid.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateByteMatchSetResponse createByteMatchSet(Consumer<CreateByteMatchSetRequest.Builder> createByteMatchSetRequest) throws WafDisallowedNameException, WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a ByteMatchSet
. You then use UpdateByteMatchSet to identify the part of a web request
that you want AWS WAF to inspect, such as the values of the User-Agent
header or the query string.
For example, you can create a ByteMatchSet
that matches any requests with User-Agent
headers that contain the string BadBot
. You can then configure AWS WAF to reject those requests.
To create and configure a ByteMatchSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateByteMatchSet
request.
Submit a CreateByteMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateByteMatchSet
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 via CreateByteMatchSetRequest.builder()
createByteMatchSetRequest
- A Consumer
that will call methods on CreateByteMatchSetRequest.Builder
to create a
request.WafDisallowedNameException
- The name specified is invalid.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateGeoMatchSetResponse createGeoMatchSet(CreateGeoMatchSetRequest createGeoMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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 a
CreateGeoMatchSet
request.
Submit a CreateGeoMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
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.
createGeoMatchSetRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafDisallowedNameException
- The name specified is invalid.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateGeoMatchSetResponse createGeoMatchSet(Consumer<CreateGeoMatchSetRequest.Builder> createGeoMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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 a
CreateGeoMatchSet
request.
Submit a CreateGeoMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
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 via CreateGeoMatchSetRequest.builder()
createGeoMatchSetRequest
- A Consumer
that will call methods on CreateGeoMatchSetRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafDisallowedNameException
- The name specified is invalid.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateIpSetResponse createIPSet(CreateIpSetRequest createIpSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates an IPSet, which you use to specify which web requests 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 a
CreateIPSet
request.
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.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createIpSetRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafDisallowedNameException
- The name specified is invalid.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateIpSetResponse createIPSet(Consumer<CreateIpSetRequest.Builder> createIpSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates an IPSet, which you use to specify which web requests 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 a
CreateIPSet
request.
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.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the CreateIpSetRequest.Builder
avoiding the need to
create one manually via CreateIpSetRequest.builder()
createIpSetRequest
- A Consumer
that will call methods on CreateIPSetRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafDisallowedNameException
- The name specified is invalid.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRateBasedRuleResponse createRateBasedRule(CreateRateBasedRuleRequest createRateBasedRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a RateBasedRule. The RateBasedRule
contains a RateLimit
, which specifies
the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The
RateBasedRule
also contains the IPSet
objects, ByteMatchSet
objects, and
other predicates that identify the requests that you want to count or block if these requests exceed the
RateLimit
.
If you add more than one predicate to a RateBasedRule
, a request not only must exceed the
RateLimit
, but it also must match all the specifications to be counted or blocked. For example,
suppose you add the following to a RateBasedRule
:
An IPSet
that matches the IP address 192.0.2.44/32
A ByteMatchSet
that matches BadBot
in the User-Agent
header
Further, you specify a RateLimit
of 15,000.
You then add the RateBasedRule
to a WebACL
and specify that you want to block requests
that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44
and the User-Agent
header in the request must contain the value BadBot
. Further,
requests that match these two conditions must be received at a rate of more than 15,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 15,000 for a five-minute period, AWS WAF no longer blocks the requests.
As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could
add the following to a RateBasedRule
:
A ByteMatchSet
with FieldToMatch
of URI
A PositionalConstraint
of STARTS_WITH
A TargetString
of login
Further, you specify a RateLimit
of 15,000.
By adding this RateBasedRule
to a WebACL
, you could limit requests to your login page
without affecting the rest of your site.
To create and configure a RateBasedRule
, perform the following steps:
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 a
CreateRule
request.
Submit a CreateRateBasedRule
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
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 the RateBasedRule
. For more information, see
CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createRateBasedRuleRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafDisallowedNameException
- The name specified is invalid.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRateBasedRuleResponse createRateBasedRule(Consumer<CreateRateBasedRuleRequest.Builder> createRateBasedRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a RateBasedRule. The RateBasedRule
contains a RateLimit
, which specifies
the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The
RateBasedRule
also contains the IPSet
objects, ByteMatchSet
objects, and
other predicates that identify the requests that you want to count or block if these requests exceed the
RateLimit
.
If you add more than one predicate to a RateBasedRule
, a request not only must exceed the
RateLimit
, but it also must match all the specifications to be counted or blocked. For example,
suppose you add the following to a RateBasedRule
:
An IPSet
that matches the IP address 192.0.2.44/32
A ByteMatchSet
that matches BadBot
in the User-Agent
header
Further, you specify a RateLimit
of 15,000.
You then add the RateBasedRule
to a WebACL
and specify that you want to block requests
that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44
and the User-Agent
header in the request must contain the value BadBot
. Further,
requests that match these two conditions must be received at a rate of more than 15,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 15,000 for a five-minute period, AWS WAF no longer blocks the requests.
As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could
add the following to a RateBasedRule
:
A ByteMatchSet
with FieldToMatch
of URI
A PositionalConstraint
of STARTS_WITH
A TargetString
of login
Further, you specify a RateLimit
of 15,000.
By adding this RateBasedRule
to a WebACL
, you could limit requests to your login page
without affecting the rest of your site.
To create and configure a RateBasedRule
, perform the following steps:
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 a
CreateRule
request.
Submit a CreateRateBasedRule
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
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 the RateBasedRule
. For more information, see
CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the CreateRateBasedRuleRequest.Builder
avoiding the
need to create one manually via CreateRateBasedRuleRequest.builder()
createRateBasedRuleRequest
- A Consumer
that will call methods on CreateRateBasedRuleRequest.Builder
to create a
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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafDisallowedNameException
- The name specified is invalid.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRegexMatchSetResponse createRegexMatchSet(CreateRegexMatchSetRequest createRegexMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request
that you want AWS WAF to inspect, such as the values of the User-Agent
header or the query string.
For example, you can create a RegexMatchSet
that contains a RegexMatchTuple
that looks
for any requests with User-Agent
headers that match a RegexPatternSet
with pattern
B[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.
To create and configure a RegexMatchSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateRegexMatchSet
request.
Submit a CreateRegexMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexMatchSet
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.
createRegexMatchSetRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRegexMatchSetResponse createRegexMatchSet(Consumer<CreateRegexMatchSetRequest.Builder> createRegexMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request
that you want AWS WAF to inspect, such as the values of the User-Agent
header or the query string.
For example, you can create a RegexMatchSet
that contains a RegexMatchTuple
that looks
for any requests with User-Agent
headers that match a RegexPatternSet
with pattern
B[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.
To create and configure a RegexMatchSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateRegexMatchSet
request.
Submit a CreateRegexMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexMatchSet
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 via CreateRegexMatchSetRequest.builder()
createRegexMatchSetRequest
- A Consumer
that will call methods on CreateRegexMatchSetRequest.Builder
to create a
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.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRegexPatternSetResponse createRegexPatternSet(CreateRegexPatternSetRequest createRegexPatternSetRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a RegexPatternSet
. You then use UpdateRegexPatternSet to specify the regular
expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t
. You can then
configure AWS WAF to reject those requests.
To create and configure a RegexPatternSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateRegexPatternSet
request.
Submit a CreateRegexPatternSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexPatternSet
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.
createRegexPatternSetRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRegexPatternSetResponse createRegexPatternSet(Consumer<CreateRegexPatternSetRequest.Builder> createRegexPatternSetRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a RegexPatternSet
. You then use UpdateRegexPatternSet to specify the regular
expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t
. You can then
configure AWS WAF to reject those requests.
To create and configure a RegexPatternSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateRegexPatternSet
request.
Submit a CreateRegexPatternSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexPatternSet
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 via CreateRegexPatternSetRequest.builder()
createRegexPatternSetRequest
- A Consumer
that will call methods on CreateRegexPatternSetRequest.Builder
to create a
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.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRuleResponse createRule(CreateRuleRequest createRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a Rule
, which contains the IPSet
objects, ByteMatchSet
objects,
and other predicates that identify the requests that you want to block. If you add more than one predicate to a
Rule
, a request must match all of the specifications to be allowed or blocked. For example, suppose
you add the following to a Rule
:
An IPSet
that matches the IP address 192.0.2.44/32
A ByteMatchSet
that matches BadBot
in the User-Agent
header
You then add the Rule
to a WebACL
and specify that you want to blocks requests that
satisfy the Rule
. For a request to be blocked, it must come from the IP address 192.0.2.44
and the User-Agent
header in the request must contain the value BadBot
.
To create and configure a Rule
, perform the following steps:
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 a
CreateRule
request.
Submit a CreateRule
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRule
request to specify the predicates that you want to include in the
Rule
.
Create and update a WebACL
that contains the Rule
. For more information, see
CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createRuleRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafDisallowedNameException
- The name specified is invalid.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRuleResponse createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a Rule
, which contains the IPSet
objects, ByteMatchSet
objects,
and other predicates that identify the requests that you want to block. If you add more than one predicate to a
Rule
, a request must match all of the specifications to be allowed or blocked. For example, suppose
you add the following to a Rule
:
An IPSet
that matches the IP address 192.0.2.44/32
A ByteMatchSet
that matches BadBot
in the User-Agent
header
You then add the Rule
to a WebACL
and specify that you want to blocks requests that
satisfy the Rule
. For a request to be blocked, it must come from the IP address 192.0.2.44
and the User-Agent
header in the request must contain the value BadBot
.
To create and configure a Rule
, perform the following steps:
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 a
CreateRule
request.
Submit a CreateRule
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRule
request to specify the predicates that you want to include in the
Rule
.
Create and update a WebACL
that contains the Rule
. For more information, see
CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the CreateRuleRequest.Builder
avoiding the need to
create one manually via CreateRuleRequest.builder()
createRuleRequest
- A Consumer
that will call methods on CreateRuleRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafDisallowedNameException
- The name specified is invalid.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRuleGroupResponse createRuleGroup(CreateRuleGroupRequest createRuleGroupRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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.
createRuleGroupRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateRuleGroupResponse createRuleGroup(Consumer<CreateRuleGroupRequest.Builder> createRuleGroupRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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 via CreateRuleGroupRequest.builder()
createRuleGroupRequest
- A Consumer
that will call methods on CreateRuleGroupRequest.Builder
to create a 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.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateSizeConstraintSetResponse createSizeConstraintSet(CreateSizeConstraintSetRequest createSizeConstraintSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a SizeConstraintSet
. You then use UpdateSizeConstraintSet to identify the part of a
web request that you want AWS WAF to check for length, such as the length of the User-Agent
header
or the length of the query string. For example, you can create a SizeConstraintSet
that matches any
requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those
requests.
To create and configure a SizeConstraintSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateSizeConstraintSet
request.
Submit a CreateSizeConstraintSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateSizeConstraintSet
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.
createSizeConstraintSetRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafDisallowedNameException
- The name specified is invalid.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateSizeConstraintSetResponse createSizeConstraintSet(Consumer<CreateSizeConstraintSetRequest.Builder> createSizeConstraintSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a SizeConstraintSet
. You then use UpdateSizeConstraintSet to identify the part of a
web request that you want AWS WAF to check for length, such as the length of the User-Agent
header
or the length of the query string. For example, you can create a SizeConstraintSet
that matches any
requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those
requests.
To create and configure a SizeConstraintSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateSizeConstraintSet
request.
Submit a CreateSizeConstraintSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateSizeConstraintSet
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 via CreateSizeConstraintSetRequest.builder()
createSizeConstraintSetRequest
- A Consumer
that will call methods on CreateSizeConstraintSetRequest.Builder
to create a
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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafDisallowedNameException
- The name specified is invalid.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateSqlInjectionMatchSetResponse createSqlInjectionMatchSet(CreateSqlInjectionMatchSetRequest createSqlInjectionMatchSetRequest) throws WafDisallowedNameException, WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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 a
CreateSqlInjectionMatchSet
request.
Submit a CreateSqlInjectionMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
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.
createSqlInjectionMatchSetRequest
- A request to create a SqlInjectionMatchSet.WafDisallowedNameException
- The name specified is invalid.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateSqlInjectionMatchSetResponse createSqlInjectionMatchSet(Consumer<CreateSqlInjectionMatchSetRequest.Builder> createSqlInjectionMatchSetRequest) throws WafDisallowedNameException, WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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 a
CreateSqlInjectionMatchSet
request.
Submit a CreateSqlInjectionMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
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 via CreateSqlInjectionMatchSetRequest.builder()
createSqlInjectionMatchSetRequest
- A Consumer
that will call methods on CreateSqlInjectionMatchSetRequest.Builder
to create a
request. A request to create a SqlInjectionMatchSet.WafDisallowedNameException
- The name specified is invalid.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateWebAclResponse createWebACL(CreateWebAclRequest createWebAclRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a WebACL
, which contains the Rules
that identify the CloudFront web requests
that you want to allow, block, or count. AWS WAF evaluates Rules
in order based on the value of
Priority
for each Rule
.
You also specify a default action, either ALLOW
or BLOCK
. If a web request doesn't
match any of the Rules
in a WebACL
, AWS WAF responds to the request with the default
action.
To create and configure a WebACL
, perform the following steps:
Create and update the ByteMatchSet
objects and other predicates that you want to include in
Rules
. For more information, see CreateByteMatchSet, UpdateByteMatchSet,
CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules
that you want to include in the WebACL
. For more
information, see CreateRule and UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateWebACL
request.
Submit a CreateWebACL
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateWebACL request.
Submit an UpdateWebACL request to specify the Rules
that you want to include in the
WebACL
, to specify the default action, and to associate the WebACL
with a CloudFront
distribution.
For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
createWebAclRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafDisallowedNameException
- The name specified is invalid.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateWebAclResponse createWebACL(Consumer<CreateWebAclRequest.Builder> createWebAclRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafDisallowedNameException, WafInvalidParameterException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Creates a WebACL
, which contains the Rules
that identify the CloudFront web requests
that you want to allow, block, or count. AWS WAF evaluates Rules
in order based on the value of
Priority
for each Rule
.
You also specify a default action, either ALLOW
or BLOCK
. If a web request doesn't
match any of the Rules
in a WebACL
, AWS WAF responds to the request with the default
action.
To create and configure a WebACL
, perform the following steps:
Create and update the ByteMatchSet
objects and other predicates that you want to include in
Rules
. For more information, see CreateByteMatchSet, UpdateByteMatchSet,
CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules
that you want to include in the WebACL
. For more
information, see CreateRule and UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
CreateWebACL
request.
Submit a CreateWebACL
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateWebACL request.
Submit an UpdateWebACL request to specify the Rules
that you want to include in the
WebACL
, to specify the default action, and to associate the WebACL
with a CloudFront
distribution.
For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the CreateWebAclRequest.Builder
avoiding the need to
create one manually via CreateWebAclRequest.builder()
createWebAclRequest
- A Consumer
that will call methods on CreateWebACLRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafDisallowedNameException
- The name specified is invalid.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateXssMatchSetResponse createXssMatchSet(CreateXssMatchSetRequest createXssMatchSetRequest) throws WafDisallowedNameException, WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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 a
CreateXssMatchSet
request.
Submit a CreateXssMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
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.
createXssMatchSetRequest
- A request to create an XssMatchSet.WafDisallowedNameException
- The name specified is invalid.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default CreateXssMatchSetResponse createXssMatchSet(Consumer<CreateXssMatchSetRequest.Builder> createXssMatchSetRequest) throws WafDisallowedNameException, WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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 a
CreateXssMatchSet
request.
Submit a CreateXssMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
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 via CreateXssMatchSetRequest.builder()
createXssMatchSetRequest
- A Consumer
that will call methods on CreateXssMatchSetRequest.Builder
to create a request.
A request to create an XssMatchSet.WafDisallowedNameException
- The name specified is invalid.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteByteMatchSetResponse deleteByteMatchSet(DeleteByteMatchSetRequest deleteByteMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet
if it's still used in any
Rules
or if it still includes any ByteMatchTuple objects (any filters).
If you just want to remove a ByteMatchSet
from a Rule
, use UpdateRule.
To permanently delete a ByteMatchSet
, perform the following steps:
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 a
DeleteByteMatchSet
request.
Submit a DeleteByteMatchSet
request.
deleteByteMatchSetRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteByteMatchSetResponse deleteByteMatchSet(Consumer<DeleteByteMatchSetRequest.Builder> deleteByteMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet
if it's still used in any
Rules
or if it still includes any ByteMatchTuple objects (any filters).
If you just want to remove a ByteMatchSet
from a Rule
, use UpdateRule.
To permanently delete a ByteMatchSet
, perform the following steps:
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 a
DeleteByteMatchSet
request.
Submit a DeleteByteMatchSet
request.
This is a convenience which creates an instance of the DeleteByteMatchSetRequest.Builder
avoiding the
need to create one manually via DeleteByteMatchSetRequest.builder()
deleteByteMatchSetRequest
- A Consumer
that will call methods on DeleteByteMatchSetRequest.Builder
to create a
request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteGeoMatchSetResponse deleteGeoMatchSet(DeleteGeoMatchSetRequest deleteGeoMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet
if it's still used in any
Rules
or if it still includes any countries.
If you just want to remove a GeoMatchSet
from a Rule
, use UpdateRule.
To permanently delete a GeoMatchSet
from AWS WAF, perform the following steps:
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 a
DeleteGeoMatchSet
request.
Submit a DeleteGeoMatchSet
request.
deleteGeoMatchSetRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteGeoMatchSetResponse deleteGeoMatchSet(Consumer<DeleteGeoMatchSetRequest.Builder> deleteGeoMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet
if it's still used in any
Rules
or if it still includes any countries.
If you just want to remove a GeoMatchSet
from a Rule
, use UpdateRule.
To permanently delete a GeoMatchSet
from AWS WAF, perform the following steps:
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 a
DeleteGeoMatchSet
request.
Submit a DeleteGeoMatchSet
request.
This is a convenience which creates an instance of the DeleteGeoMatchSetRequest.Builder
avoiding the need
to create one manually via DeleteGeoMatchSetRequest.builder()
deleteGeoMatchSetRequest
- A Consumer
that will call methods on DeleteGeoMatchSetRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteIpSetResponse deleteIPSet(DeleteIpSetRequest deleteIpSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes an IPSet. You can't delete an IPSet
if it's still used in any
Rules
or if it still includes any IP addresses.
If you just want to remove an IPSet
from a Rule
, use UpdateRule.
To permanently delete an IPSet
from AWS WAF, perform the following steps:
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 a
DeleteIPSet
request.
Submit a DeleteIPSet
request.
deleteIpSetRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteIpSetResponse deleteIPSet(Consumer<DeleteIpSetRequest.Builder> deleteIpSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes an IPSet. You can't delete an IPSet
if it's still used in any
Rules
or if it still includes any IP addresses.
If you just want to remove an IPSet
from a Rule
, use UpdateRule.
To permanently delete an IPSet
from AWS WAF, perform the following steps:
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 a
DeleteIPSet
request.
Submit a DeleteIPSet
request.
This is a convenience which creates an instance of the DeleteIpSetRequest.Builder
avoiding the need to
create one manually via DeleteIpSetRequest.builder()
deleteIpSetRequest
- A Consumer
that will call methods on DeleteIPSetRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteLoggingConfigurationResponse deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest) throws WafInternalErrorException, WafNonexistentItemException, WafStaleDataException, AwsServiceException, SdkClientException, WafException
Permanently deletes the LoggingConfiguration from the specified web ACL.
deleteLoggingConfigurationRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteLoggingConfigurationResponse deleteLoggingConfiguration(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest) throws WafInternalErrorException, WafNonexistentItemException, WafStaleDataException, AwsServiceException, SdkClientException, WafException
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 via DeleteLoggingConfigurationRequest.builder()
deleteLoggingConfigurationRequest
- A Consumer
that will call methods on DeleteLoggingConfigurationRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeletePermissionPolicyResponse deletePermissionPolicy(DeletePermissionPolicyRequest deletePermissionPolicyRequest) throws WafInternalErrorException, WafStaleDataException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Permanently deletes an IAM policy from the specified RuleGroup.
The user making the request must be the owner of the RuleGroup.
deletePermissionPolicyRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeletePermissionPolicyResponse deletePermissionPolicy(Consumer<DeletePermissionPolicyRequest.Builder> deletePermissionPolicyRequest) throws WafInternalErrorException, WafStaleDataException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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 via DeletePermissionPolicyRequest.builder()
deletePermissionPolicyRequest
- A Consumer
that will call methods on DeletePermissionPolicyRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRateBasedRuleResponse deleteRateBasedRule(DeleteRateBasedRuleRequest deleteRateBasedRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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 as ByteMatchSet
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 a
DeleteRateBasedRule
request.
Submit a DeleteRateBasedRule
request.
deleteRateBasedRuleRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRateBasedRuleResponse deleteRateBasedRule(Consumer<DeleteRateBasedRuleRequest.Builder> deleteRateBasedRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
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 as ByteMatchSet
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 a
DeleteRateBasedRule
request.
Submit a DeleteRateBasedRule
request.
This is a convenience which creates an instance of the DeleteRateBasedRuleRequest.Builder
avoiding the
need to create one manually via DeleteRateBasedRuleRequest.builder()
deleteRateBasedRuleRequest
- A Consumer
that will call methods on DeleteRateBasedRuleRequest.Builder
to create a
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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRegexMatchSetResponse deleteRegexMatchSet(DeleteRegexMatchSetRequest deleteRegexMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet
if it's still used in
any Rules
or if it still includes any RegexMatchTuples
objects (any filters).
If you just want to remove a RegexMatchSet
from a Rule
, use UpdateRule.
To permanently delete a RegexMatchSet
, perform the following steps:
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 a
DeleteRegexMatchSet
request.
Submit a DeleteRegexMatchSet
request.
deleteRegexMatchSetRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRegexMatchSetResponse deleteRegexMatchSet(Consumer<DeleteRegexMatchSetRequest.Builder> deleteRegexMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet
if it's still used in
any Rules
or if it still includes any RegexMatchTuples
objects (any filters).
If you just want to remove a RegexMatchSet
from a Rule
, use UpdateRule.
To permanently delete a RegexMatchSet
, perform the following steps:
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 a
DeleteRegexMatchSet
request.
Submit a DeleteRegexMatchSet
request.
This is a convenience which creates an instance of the DeleteRegexMatchSetRequest.Builder
avoiding the
need to create one manually via DeleteRegexMatchSetRequest.builder()
deleteRegexMatchSetRequest
- A Consumer
that will call methods on DeleteRegexMatchSetRequest.Builder
to create a
request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRegexPatternSetResponse deleteRegexPatternSet(DeleteRegexPatternSetRequest deleteRegexPatternSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet
if it's still used
in any RegexMatchSet
or if the RegexPatternSet
is not empty.
deleteRegexPatternSetRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRegexPatternSetResponse deleteRegexPatternSet(Consumer<DeleteRegexPatternSetRequest.Builder> deleteRegexPatternSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet
if it's still used
in any RegexMatchSet
or if the RegexPatternSet
is not empty.
This is a convenience which creates an instance of the DeleteRegexPatternSetRequest.Builder
avoiding the
need to create one manually via DeleteRegexPatternSetRequest.builder()
deleteRegexPatternSetRequest
- A Consumer
that will call methods on DeleteRegexPatternSetRequest.Builder
to create a
request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRuleResponse deleteRule(DeleteRuleRequest deleteRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a Rule. You can't delete a Rule
if it's still used in any
WebACL
objects or if it still includes any predicates, such as ByteMatchSet
objects.
If you just want to remove a Rule
from a WebACL
, 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 a
DeleteRule
request.
Submit a DeleteRule
request.
deleteRuleRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRuleResponse deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a Rule. You can't delete a Rule
if it's still used in any
WebACL
objects or if it still includes any predicates, such as ByteMatchSet
objects.
If you just want to remove a Rule
from a WebACL
, 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 a
DeleteRule
request.
Submit a DeleteRule
request.
This is a convenience which creates an instance of the DeleteRuleRequest.Builder
avoiding the need to
create one manually via DeleteRuleRequest.builder()
deleteRuleRequest
- A Consumer
that will call methods on DeleteRuleRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRuleGroupResponse deleteRuleGroup(DeleteRuleGroupRequest deleteRuleGroupRequest) throws WafStaleDataException, WafInternalErrorException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, WafInvalidOperationException, AwsServiceException, SdkClientException, WafException
Permanently deletes a RuleGroup. You can't delete a RuleGroup
if it's still used in any
WebACL
objects or if it still includes any rules.
If you just want to remove a RuleGroup
from a WebACL
, use UpdateWebACL.
To permanently delete a RuleGroup
from AWS WAF, perform the following steps:
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 a
DeleteRuleGroup
request.
Submit a DeleteRuleGroup
request.
deleteRuleGroupRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteRuleGroupResponse deleteRuleGroup(Consumer<DeleteRuleGroupRequest.Builder> deleteRuleGroupRequest) throws WafStaleDataException, WafInternalErrorException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, WafInvalidOperationException, AwsServiceException, SdkClientException, WafException
Permanently deletes a RuleGroup. You can't delete a RuleGroup
if it's still used in any
WebACL
objects or if it still includes any rules.
If you just want to remove a RuleGroup
from a WebACL
, use UpdateWebACL.
To permanently delete a RuleGroup
from AWS WAF, perform the following steps:
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 a
DeleteRuleGroup
request.
Submit a DeleteRuleGroup
request.
This is a convenience which creates an instance of the DeleteRuleGroupRequest.Builder
avoiding the need
to create one manually via DeleteRuleGroupRequest.builder()
deleteRuleGroupRequest
- A Consumer
that will call methods on DeleteRuleGroupRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteSizeConstraintSetResponse deleteSizeConstraintSet(DeleteSizeConstraintSetRequest deleteSizeConstraintSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet
if it's still
used in any Rules
or if it still includes any SizeConstraint objects (any filters).
If you just want to remove a SizeConstraintSet
from a Rule
, use UpdateRule.
To permanently delete a SizeConstraintSet
, perform the following steps:
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 a
DeleteSizeConstraintSet
request.
Submit a DeleteSizeConstraintSet
request.
deleteSizeConstraintSetRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteSizeConstraintSetResponse deleteSizeConstraintSet(Consumer<DeleteSizeConstraintSetRequest.Builder> deleteSizeConstraintSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet
if it's still
used in any Rules
or if it still includes any SizeConstraint objects (any filters).
If you just want to remove a SizeConstraintSet
from a Rule
, use UpdateRule.
To permanently delete a SizeConstraintSet
, perform the following steps:
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 a
DeleteSizeConstraintSet
request.
Submit a DeleteSizeConstraintSet
request.
This is a convenience which creates an instance of the DeleteSizeConstraintSetRequest.Builder
avoiding
the need to create one manually via DeleteSizeConstraintSetRequest.builder()
deleteSizeConstraintSetRequest
- A Consumer
that will call methods on DeleteSizeConstraintSetRequest.Builder
to create a
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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteSqlInjectionMatchSetResponse deleteSqlInjectionMatchSet(DeleteSqlInjectionMatchSetRequest deleteSqlInjectionMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet
if it's
still used in any Rules
or if it still contains any SqlInjectionMatchTuple objects.
If you just want to remove a SqlInjectionMatchSet
from a Rule
, 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 a
DeleteSqlInjectionMatchSet
request.
Submit a DeleteSqlInjectionMatchSet
request.
deleteSqlInjectionMatchSetRequest
- A request to delete a SqlInjectionMatchSet from AWS WAF.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteSqlInjectionMatchSetResponse deleteSqlInjectionMatchSet(Consumer<DeleteSqlInjectionMatchSetRequest.Builder> deleteSqlInjectionMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet
if it's
still used in any Rules
or if it still contains any SqlInjectionMatchTuple objects.
If you just want to remove a SqlInjectionMatchSet
from a Rule
, 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 a
DeleteSqlInjectionMatchSet
request.
Submit a DeleteSqlInjectionMatchSet
request.
This is a convenience which creates an instance of the DeleteSqlInjectionMatchSetRequest.Builder
avoiding
the need to create one manually via DeleteSqlInjectionMatchSetRequest.builder()
deleteSqlInjectionMatchSetRequest
- A Consumer
that will call methods on DeleteSqlInjectionMatchSetRequest.Builder
to create a
request. A request to delete a SqlInjectionMatchSet from AWS WAF.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteWebAclResponse deleteWebACL(DeleteWebAclRequest deleteWebAclRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a WebACL. You can't delete a WebACL
if it still contains any
Rules
.
To delete a WebACL
, perform the following steps:
Update the WebACL
to remove Rules
, if any. For more information, see
UpdateWebACL.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteWebACL
request.
Submit a DeleteWebACL
request.
deleteWebAclRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteWebAclResponse deleteWebACL(Consumer<DeleteWebAclRequest.Builder> deleteWebAclRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes a WebACL. You can't delete a WebACL
if it still contains any
Rules
.
To delete a WebACL
, perform the following steps:
Update the WebACL
to remove Rules
, if any. For more information, see
UpdateWebACL.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a
DeleteWebACL
request.
Submit a DeleteWebACL
request.
This is a convenience which creates an instance of the DeleteWebAclRequest.Builder
avoiding the need to
create one manually via DeleteWebAclRequest.builder()
deleteWebAclRequest
- A Consumer
that will call methods on DeleteWebACLRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteXssMatchSetResponse deleteXssMatchSet(DeleteXssMatchSetRequest deleteXssMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes an XssMatchSet. You can't delete an XssMatchSet
if it's still used in any
Rules
or if it still contains any XssMatchTuple objects.
If you just want to remove an XssMatchSet
from a Rule
, use UpdateRule.
To permanently delete an XssMatchSet
from AWS WAF, perform the following steps:
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 a
DeleteXssMatchSet
request.
Submit a DeleteXssMatchSet
request.
deleteXssMatchSetRequest
- A request to delete an XssMatchSet from AWS WAF.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DeleteXssMatchSetResponse deleteXssMatchSet(Consumer<DeleteXssMatchSetRequest.Builder> deleteXssMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafReferencedItemException, WafStaleDataException, WafNonEmptyEntityException, AwsServiceException, SdkClientException, WafException
Permanently deletes an XssMatchSet. You can't delete an XssMatchSet
if it's still used in any
Rules
or if it still contains any XssMatchTuple objects.
If you just want to remove an XssMatchSet
from a Rule
, use UpdateRule.
To permanently delete an XssMatchSet
from AWS WAF, perform the following steps:
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 a
DeleteXssMatchSet
request.
Submit a DeleteXssMatchSet
request.
This is a convenience which creates an instance of the DeleteXssMatchSetRequest.Builder
avoiding the need
to create one manually via DeleteXssMatchSetRequest.builder()
deleteXssMatchSetRequest
- A Consumer
that will call methods on DeleteXssMatchSetRequest.Builder
to create a request.
A request to delete an XssMatchSet from AWS WAF.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafNonEmptyEntityException
- The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects
or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DisassociateWebAclResponse disassociateWebACL(DisassociateWebAclRequest disassociateWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Removes a web ACL from the specified resource.
disassociateWebAclRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default DisassociateWebAclResponse disassociateWebACL(Consumer<DisassociateWebAclRequest.Builder> disassociateWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidParameterException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Removes a web ACL from the specified resource.
This is a convenience which creates an instance of the DisassociateWebAclRequest.Builder
avoiding the
need to create one manually via DisassociateWebAclRequest.builder()
disassociateWebAclRequest
- A Consumer
that will call methods on DisassociateWebACLRequest.Builder
to create a
request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetByteMatchSetResponse getByteMatchSet(GetByteMatchSetRequest getByteMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the ByteMatchSet specified by ByteMatchSetId
.
getByteMatchSetRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetByteMatchSetResponse getByteMatchSet(Consumer<GetByteMatchSetRequest.Builder> getByteMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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 via GetByteMatchSetRequest.builder()
getByteMatchSetRequest
- A Consumer
that will call methods on GetByteMatchSetRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetChangeTokenResponse getChangeToken() throws WafInternalErrorException, AwsServiceException, SdkClientException, WafException
When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If your application submits a
GetChangeToken
request and then submits a second GetChangeToken
request before
submitting a create, update, or delete request, the second GetChangeToken
request returns the same
value as the first GetChangeToken
request.
When you use a change token in a create, update, or delete request, the status of the change token changes to
PENDING
, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use
GetChangeTokenStatus
to determine the status of your change token.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
getChangeToken(GetChangeTokenRequest)
,
AWS
API Documentationdefault GetChangeTokenResponse getChangeToken(GetChangeTokenRequest getChangeTokenRequest) throws WafInternalErrorException, AwsServiceException, SdkClientException, WafException
When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If your application submits a
GetChangeToken
request and then submits a second GetChangeToken
request before
submitting a create, update, or delete request, the second GetChangeToken
request returns the same
value as the first GetChangeToken
request.
When you use a change token in a create, update, or delete request, the status of the change token changes to
PENDING
, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use
GetChangeTokenStatus
to determine the status of your change token.
getChangeTokenRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetChangeTokenResponse getChangeToken(Consumer<GetChangeTokenRequest.Builder> getChangeTokenRequest) throws WafInternalErrorException, AwsServiceException, SdkClientException, WafException
When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If your application submits a
GetChangeToken
request and then submits a second GetChangeToken
request before
submitting a create, update, or delete request, the second GetChangeToken
request returns the same
value as the first GetChangeToken
request.
When you use a change token in a create, update, or delete request, the status of the change token changes to
PENDING
, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use
GetChangeTokenStatus
to determine the status of your change token.
This is a convenience which creates an instance of the GetChangeTokenRequest.Builder
avoiding the need to
create one manually via GetChangeTokenRequest.builder()
getChangeTokenRequest
- A Consumer
that will call methods on GetChangeTokenRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetChangeTokenStatusResponse getChangeTokenStatus(GetChangeTokenStatusRequest getChangeTokenStatusRequest) throws WafNonexistentItemException, WafInternalErrorException, AwsServiceException, SdkClientException, WafException
Returns the status of a ChangeToken
that you got by calling GetChangeToken.
ChangeTokenStatus
is one of the following values:
PROVISIONED
: You requested the change token by calling GetChangeToken
, but you haven't
used it yet in a call to create, update, or delete an AWS WAF object.
PENDING
: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.
IN_SYNC
: Propagation is complete.
getChangeTokenStatusRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetChangeTokenStatusResponse getChangeTokenStatus(Consumer<GetChangeTokenStatusRequest.Builder> getChangeTokenStatusRequest) throws WafNonexistentItemException, WafInternalErrorException, AwsServiceException, SdkClientException, WafException
Returns the status of a ChangeToken
that you got by calling GetChangeToken.
ChangeTokenStatus
is one of the following values:
PROVISIONED
: You requested the change token by calling GetChangeToken
, but you haven't
used it yet in a call to create, update, or delete an AWS WAF object.
PENDING
: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.
IN_SYNC
: Propagation is complete.
This is a convenience which creates an instance of the GetChangeTokenStatusRequest.Builder
avoiding the
need to create one manually via GetChangeTokenStatusRequest.builder()
getChangeTokenStatusRequest
- A Consumer
that will call methods on GetChangeTokenStatusRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetGeoMatchSetResponse getGeoMatchSet(GetGeoMatchSetRequest getGeoMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the GeoMatchSet that is specified by GeoMatchSetId
.
getGeoMatchSetRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetGeoMatchSetResponse getGeoMatchSet(Consumer<GetGeoMatchSetRequest.Builder> getGeoMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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 via GetGeoMatchSetRequest.builder()
getGeoMatchSetRequest
- A Consumer
that will call methods on GetGeoMatchSetRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetIpSetResponse getIPSet(GetIpSetRequest getIpSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the IPSet that is specified by IPSetId
.
getIpSetRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetIpSetResponse getIPSet(Consumer<GetIpSetRequest.Builder> getIpSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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 via GetIpSetRequest.builder()
getIpSetRequest
- A Consumer
that will call methods on GetIPSetRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetLoggingConfigurationResponse getLoggingConfiguration(GetLoggingConfigurationRequest getLoggingConfigurationRequest) throws WafInternalErrorException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the LoggingConfiguration for the specified web ACL.
getLoggingConfigurationRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetLoggingConfigurationResponse getLoggingConfiguration(Consumer<GetLoggingConfigurationRequest.Builder> getLoggingConfigurationRequest) throws WafInternalErrorException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the LoggingConfiguration for the specified web ACL.
This is a convenience which creates an instance of the GetLoggingConfigurationRequest.Builder
avoiding
the need to create one manually via GetLoggingConfigurationRequest.builder()
getLoggingConfigurationRequest
- A Consumer
that will call methods on GetLoggingConfigurationRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetPermissionPolicyResponse getPermissionPolicy(GetPermissionPolicyRequest getPermissionPolicyRequest) throws WafInternalErrorException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the IAM policy attached to the RuleGroup.
getPermissionPolicyRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetPermissionPolicyResponse getPermissionPolicy(Consumer<GetPermissionPolicyRequest.Builder> getPermissionPolicyRequest) throws WafInternalErrorException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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 via GetPermissionPolicyRequest.builder()
getPermissionPolicyRequest
- A Consumer
that will call methods on GetPermissionPolicyRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRateBasedRuleResponse getRateBasedRule(GetRateBasedRuleRequest getRateBasedRuleRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the RateBasedRule that is specified by the RuleId
that you included in the
GetRateBasedRule
request.
getRateBasedRuleRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRateBasedRuleResponse getRateBasedRule(Consumer<GetRateBasedRuleRequest.Builder> getRateBasedRuleRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the RateBasedRule that is specified by the RuleId
that you included in the
GetRateBasedRule
request.
This is a convenience which creates an instance of the GetRateBasedRuleRequest.Builder
avoiding the need
to create one manually via GetRateBasedRuleRequest.builder()
getRateBasedRuleRequest
- A Consumer
that will call methods on GetRateBasedRuleRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRateBasedRuleManagedKeysResponse getRateBasedRuleManagedKeys(GetRateBasedRuleManagedKeysRequest getRateBasedRuleManagedKeysRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
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.
getRateBasedRuleManagedKeysRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRateBasedRuleManagedKeysResponse getRateBasedRuleManagedKeys(Consumer<GetRateBasedRuleManagedKeysRequest.Builder> getRateBasedRuleManagedKeysRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the
RuleId
. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000
addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.
This is a convenience which creates an instance of the GetRateBasedRuleManagedKeysRequest.Builder
avoiding the need to create one manually via GetRateBasedRuleManagedKeysRequest.builder()
getRateBasedRuleManagedKeysRequest
- A Consumer
that will call methods on GetRateBasedRuleManagedKeysRequest.Builder
to create
a request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRegexMatchSetResponse getRegexMatchSet(GetRegexMatchSetRequest getRegexMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the RegexMatchSet specified by RegexMatchSetId
.
getRegexMatchSetRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRegexMatchSetResponse getRegexMatchSet(Consumer<GetRegexMatchSetRequest.Builder> getRegexMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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 via GetRegexMatchSetRequest.builder()
getRegexMatchSetRequest
- A Consumer
that will call methods on GetRegexMatchSetRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRegexPatternSetResponse getRegexPatternSet(GetRegexPatternSetRequest getRegexPatternSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the RegexPatternSet specified by RegexPatternSetId
.
getRegexPatternSetRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRegexPatternSetResponse getRegexPatternSet(Consumer<GetRegexPatternSetRequest.Builder> getRegexPatternSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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 via GetRegexPatternSetRequest.builder()
getRegexPatternSetRequest
- A Consumer
that will call methods on GetRegexPatternSetRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRuleResponse getRule(GetRuleRequest getRuleRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the Rule that is specified by the RuleId
that you included in the
GetRule
request.
getRuleRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRuleResponse getRule(Consumer<GetRuleRequest.Builder> getRuleRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the Rule that is specified by the RuleId
that you included in the
GetRule
request.
This is a convenience which creates an instance of the GetRuleRequest.Builder
avoiding the need to create
one manually via GetRuleRequest.builder()
getRuleRequest
- A Consumer
that will call methods on GetRuleRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRuleGroupResponse getRuleGroup(GetRuleGroupRequest getRuleGroupRequest) throws WafInternalErrorException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the RuleGroup that is specified by the RuleGroupId
that you included in the
GetRuleGroup
request.
To view the rules in a rule group, use ListActivatedRulesInRuleGroup.
getRuleGroupRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetRuleGroupResponse getRuleGroup(Consumer<GetRuleGroupRequest.Builder> getRuleGroupRequest) throws WafInternalErrorException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the RuleGroup that is specified by the RuleGroupId
that you included in the
GetRuleGroup
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 via GetRuleGroupRequest.builder()
getRuleGroupRequest
- A Consumer
that will call methods on GetRuleGroupRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetSampledRequestsResponse getSampledRequests(GetSampledRequestsRequest getSampledRequestsRequest) throws WafNonexistentItemException, WafInternalErrorException, AwsServiceException, SdkClientException, WafException
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.
getSampledRequestsRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetSampledRequestsResponse getSampledRequests(Consumer<GetSampledRequestsRequest.Builder> getSampledRequestsRequest) throws WafNonexistentItemException, WafInternalErrorException, AwsServiceException, SdkClientException, WafException
Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.
GetSampledRequests
returns a time range, which is usually the time range that you specified.
However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time
range elapsed, GetSampledRequests
returns an updated time range. This new time range indicates the
actual period during which AWS WAF selected the requests in the sample.
This is a convenience which creates an instance of the GetSampledRequestsRequest.Builder
avoiding the
need to create one manually via GetSampledRequestsRequest.builder()
getSampledRequestsRequest
- A Consumer
that will call methods on GetSampledRequestsRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetSizeConstraintSetResponse getSizeConstraintSet(GetSizeConstraintSetRequest getSizeConstraintSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the SizeConstraintSet specified by SizeConstraintSetId
.
getSizeConstraintSetRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetSizeConstraintSetResponse getSizeConstraintSet(Consumer<GetSizeConstraintSetRequest.Builder> getSizeConstraintSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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 via GetSizeConstraintSetRequest.builder()
getSizeConstraintSetRequest
- A Consumer
that will call methods on GetSizeConstraintSetRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetSqlInjectionMatchSetResponse getSqlInjectionMatchSet(GetSqlInjectionMatchSetRequest getSqlInjectionMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId
.
getSqlInjectionMatchSetRequest
- A request to get a SqlInjectionMatchSet.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetSqlInjectionMatchSetResponse getSqlInjectionMatchSet(Consumer<GetSqlInjectionMatchSetRequest.Builder> getSqlInjectionMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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 via GetSqlInjectionMatchSetRequest.builder()
getSqlInjectionMatchSetRequest
- A Consumer
that will call methods on GetSqlInjectionMatchSetRequest.Builder
to create a
request. A request to get a SqlInjectionMatchSet.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetWebAclResponse getWebACL(GetWebAclRequest getWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the WebACL that is specified by WebACLId
.
getWebAclRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetWebAclResponse getWebACL(Consumer<GetWebAclRequest.Builder> getWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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 via GetWebAclRequest.builder()
getWebAclRequest
- A Consumer
that will call methods on GetWebACLRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetWebAclForResourceResponse getWebACLForResource(GetWebAclForResourceRequest getWebAclForResourceRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafInvalidParameterException, WafUnavailableEntityException, AwsServiceException, SdkClientException, WafException
Returns the web ACL for the specified resource.
getWebAclForResourceRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafUnavailableEntityException
- The operation failed because the entity referenced is temporarily unavailable. 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetWebAclForResourceResponse getWebACLForResource(Consumer<GetWebAclForResourceRequest.Builder> getWebAclForResourceRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafInvalidParameterException, WafUnavailableEntityException, AwsServiceException, SdkClientException, WafException
Returns the web ACL for the specified resource.
This is a convenience which creates an instance of the GetWebAclForResourceRequest.Builder
avoiding the
need to create one manually via GetWebAclForResourceRequest.builder()
getWebAclForResourceRequest
- A Consumer
that will call methods on GetWebACLForResourceRequest.Builder
to create a
request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafUnavailableEntityException
- The operation failed because the entity referenced is temporarily unavailable. 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetXssMatchSetResponse getXssMatchSet(GetXssMatchSetRequest getXssMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
Returns the XssMatchSet that is specified by XssMatchSetId
.
getXssMatchSetRequest
- A request to get an XssMatchSet.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default GetXssMatchSetResponse getXssMatchSet(Consumer<GetXssMatchSetRequest.Builder> getXssMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, AwsServiceException, SdkClientException, WafException
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 via GetXssMatchSetRequest.builder()
getXssMatchSetRequest
- A Consumer
that will call methods on GetXssMatchSetRequest.Builder
to create a request. A
request to get an XssMatchSet.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListActivatedRulesInRuleGroupResponse listActivatedRulesInRuleGroup(ListActivatedRulesInRuleGroupRequest listActivatedRulesInRuleGroupRequest) throws WafInternalErrorException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
Returns an array of ActivatedRule objects.
listActivatedRulesInRuleGroupRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListActivatedRulesInRuleGroupResponse listActivatedRulesInRuleGroup(Consumer<ListActivatedRulesInRuleGroupRequest.Builder> listActivatedRulesInRuleGroupRequest) throws WafInternalErrorException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
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 via ListActivatedRulesInRuleGroupRequest.builder()
listActivatedRulesInRuleGroupRequest
- A Consumer
that will call methods on ListActivatedRulesInRuleGroupRequest.Builder
to
create a request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListByteMatchSetsResponse listByteMatchSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of ByteMatchSetSummary objects.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listByteMatchSets(ListByteMatchSetsRequest)
,
AWS
API Documentationdefault ListByteMatchSetsResponse listByteMatchSets(ListByteMatchSetsRequest listByteMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of ByteMatchSetSummary objects.
listByteMatchSetsRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListByteMatchSetsResponse listByteMatchSets(Consumer<ListByteMatchSetsRequest.Builder> listByteMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 via ListByteMatchSetsRequest.builder()
listByteMatchSetsRequest
- A Consumer
that will call methods on ListByteMatchSetsRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListGeoMatchSetsResponse listGeoMatchSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of GeoMatchSetSummary objects in the response.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listGeoMatchSets(ListGeoMatchSetsRequest)
,
AWS
API Documentationdefault ListGeoMatchSetsResponse listGeoMatchSets(ListGeoMatchSetsRequest listGeoMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of GeoMatchSetSummary objects in the response.
listGeoMatchSetsRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListGeoMatchSetsResponse listGeoMatchSets(Consumer<ListGeoMatchSetsRequest.Builder> listGeoMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 via ListGeoMatchSetsRequest.builder()
listGeoMatchSetsRequest
- A Consumer
that will call methods on ListGeoMatchSetsRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListIpSetsResponse listIPSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of IPSetSummary objects in the response.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listIPSets(ListIpSetsRequest)
,
AWS API
Documentationdefault ListIpSetsResponse listIPSets(ListIpSetsRequest listIpSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of IPSetSummary objects in the response.
listIpSetsRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListIpSetsResponse listIPSets(Consumer<ListIpSetsRequest.Builder> listIpSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 via ListIpSetsRequest.builder()
listIpSetsRequest
- A Consumer
that will call methods on ListIPSetsRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListLoggingConfigurationsResponse listLoggingConfigurations(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest) throws WafInternalErrorException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
Returns an array of LoggingConfiguration objects.
listLoggingConfigurationsRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListLoggingConfigurationsResponse listLoggingConfigurations(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest) throws WafInternalErrorException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
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 via ListLoggingConfigurationsRequest.builder()
listLoggingConfigurationsRequest
- A Consumer
that will call methods on ListLoggingConfigurationsRequest.Builder
to create a
request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRateBasedRulesResponse listRateBasedRules() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of RuleSummary objects.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listRateBasedRules(ListRateBasedRulesRequest)
,
AWS API Documentationdefault ListRateBasedRulesResponse listRateBasedRules(ListRateBasedRulesRequest listRateBasedRulesRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of RuleSummary objects.
listRateBasedRulesRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRateBasedRulesResponse listRateBasedRules(Consumer<ListRateBasedRulesRequest.Builder> listRateBasedRulesRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 via ListRateBasedRulesRequest.builder()
listRateBasedRulesRequest
- A Consumer
that will call methods on ListRateBasedRulesRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRegexMatchSetsResponse listRegexMatchSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of RegexMatchSetSummary objects.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listRegexMatchSets(ListRegexMatchSetsRequest)
,
AWS API Documentationdefault ListRegexMatchSetsResponse listRegexMatchSets(ListRegexMatchSetsRequest listRegexMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of RegexMatchSetSummary objects.
listRegexMatchSetsRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRegexMatchSetsResponse listRegexMatchSets(Consumer<ListRegexMatchSetsRequest.Builder> listRegexMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 via ListRegexMatchSetsRequest.builder()
listRegexMatchSetsRequest
- A Consumer
that will call methods on ListRegexMatchSetsRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRegexPatternSetsResponse listRegexPatternSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of RegexPatternSetSummary objects.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listRegexPatternSets(ListRegexPatternSetsRequest)
,
AWS API Documentationdefault ListRegexPatternSetsResponse listRegexPatternSets(ListRegexPatternSetsRequest listRegexPatternSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of RegexPatternSetSummary objects.
listRegexPatternSetsRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRegexPatternSetsResponse listRegexPatternSets(Consumer<ListRegexPatternSetsRequest.Builder> listRegexPatternSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 via ListRegexPatternSetsRequest.builder()
listRegexPatternSetsRequest
- A Consumer
that will call methods on ListRegexPatternSetsRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListResourcesForWebAclResponse listResourcesForWebACL(ListResourcesForWebAclRequest listResourcesForWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
Returns an array of resources associated with the specified web ACL.
listResourcesForWebAclRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListResourcesForWebAclResponse listResourcesForWebACL(Consumer<ListResourcesForWebAclRequest.Builder> listResourcesForWebAclRequest) throws WafInternalErrorException, WafInvalidAccountException, WafNonexistentItemException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
Returns an array of resources associated with the specified web ACL.
This is a convenience which creates an instance of the ListResourcesForWebAclRequest.Builder
avoiding the
need to create one manually via ListResourcesForWebAclRequest.builder()
listResourcesForWebAclRequest
- A Consumer
that will call methods on ListResourcesForWebACLRequest.Builder
to create a
request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRuleGroupsResponse listRuleGroups() throws WafInternalErrorException, AwsServiceException, SdkClientException, WafException
Returns an array of RuleGroup objects.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listRuleGroups(ListRuleGroupsRequest)
,
AWS
API Documentationdefault ListRuleGroupsResponse listRuleGroups(ListRuleGroupsRequest listRuleGroupsRequest) throws WafInternalErrorException, AwsServiceException, SdkClientException, WafException
Returns an array of RuleGroup objects.
listRuleGroupsRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRuleGroupsResponse listRuleGroups(Consumer<ListRuleGroupsRequest.Builder> listRuleGroupsRequest) throws WafInternalErrorException, AwsServiceException, SdkClientException, WafException
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 via ListRuleGroupsRequest.builder()
listRuleGroupsRequest
- A Consumer
that will call methods on ListRuleGroupsRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRulesResponse listRules() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of RuleSummary objects.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listRules(ListRulesRequest)
,
AWS API
Documentationdefault ListRulesResponse listRules(ListRulesRequest listRulesRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of RuleSummary objects.
listRulesRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListRulesResponse listRules(Consumer<ListRulesRequest.Builder> listRulesRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 via ListRulesRequest.builder()
listRulesRequest
- A Consumer
that will call methods on ListRulesRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListSizeConstraintSetsResponse listSizeConstraintSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of SizeConstraintSetSummary objects.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listSizeConstraintSets(ListSizeConstraintSetsRequest)
,
AWS API Documentationdefault ListSizeConstraintSetsResponse listSizeConstraintSets(ListSizeConstraintSetsRequest listSizeConstraintSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of SizeConstraintSetSummary objects.
listSizeConstraintSetsRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListSizeConstraintSetsResponse listSizeConstraintSets(Consumer<ListSizeConstraintSetsRequest.Builder> listSizeConstraintSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 via ListSizeConstraintSetsRequest.builder()
listSizeConstraintSetsRequest
- A Consumer
that will call methods on ListSizeConstraintSetsRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListSqlInjectionMatchSetsResponse listSqlInjectionMatchSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of SqlInjectionMatchSet objects.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listSqlInjectionMatchSets(ListSqlInjectionMatchSetsRequest)
,
AWS API Documentationdefault ListSqlInjectionMatchSetsResponse listSqlInjectionMatchSets(ListSqlInjectionMatchSetsRequest listSqlInjectionMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of SqlInjectionMatchSet objects.
listSqlInjectionMatchSetsRequest
- A request to list the SqlInjectionMatchSet objects created by the current AWS account.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListSqlInjectionMatchSetsResponse listSqlInjectionMatchSets(Consumer<ListSqlInjectionMatchSetsRequest.Builder> listSqlInjectionMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 via ListSqlInjectionMatchSetsRequest.builder()
listSqlInjectionMatchSetsRequest
- A Consumer
that will call methods on ListSqlInjectionMatchSetsRequest.Builder
to create a
request. A request to list the SqlInjectionMatchSet objects created by the current AWS account.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListSubscribedRuleGroupsResponse listSubscribedRuleGroups() throws WafNonexistentItemException, WafInternalErrorException, AwsServiceException, SdkClientException, WafException
Returns an array of RuleGroup objects that you are subscribed to.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listSubscribedRuleGroups(ListSubscribedRuleGroupsRequest)
,
AWS API Documentationdefault ListSubscribedRuleGroupsResponse listSubscribedRuleGroups(ListSubscribedRuleGroupsRequest listSubscribedRuleGroupsRequest) throws WafNonexistentItemException, WafInternalErrorException, AwsServiceException, SdkClientException, WafException
Returns an array of RuleGroup objects that you are subscribed to.
listSubscribedRuleGroupsRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListSubscribedRuleGroupsResponse listSubscribedRuleGroups(Consumer<ListSubscribedRuleGroupsRequest.Builder> listSubscribedRuleGroupsRequest) throws WafNonexistentItemException, WafInternalErrorException, AwsServiceException, SdkClientException, WafException
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 via ListSubscribedRuleGroupsRequest.builder()
listSubscribedRuleGroupsRequest
- A Consumer
that will call methods on ListSubscribedRuleGroupsRequest.Builder
to create a
request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListWebAcLsResponse listWebACLs() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of WebACLSummary objects in the response.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listWebACLs(ListWebAcLsRequest)
,
AWS API
Documentationdefault ListWebAcLsResponse listWebACLs(ListWebAcLsRequest listWebAcLsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of WebACLSummary objects in the response.
listWebAcLsRequest
- 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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListWebAcLsResponse listWebACLs(Consumer<ListWebAcLsRequest.Builder> listWebAcLsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 via ListWebAcLsRequest.builder()
listWebAcLsRequest
- A Consumer
that will call methods on ListWebACLsRequest.Builder
to create a request.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListXssMatchSetsResponse listXssMatchSets() throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of XssMatchSet objects.
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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
listXssMatchSets(ListXssMatchSetsRequest)
,
AWS
API Documentationdefault ListXssMatchSetsResponse listXssMatchSets(ListXssMatchSetsRequest listXssMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Returns an array of XssMatchSet objects.
listXssMatchSetsRequest
- A request to list the XssMatchSet objects created by the current AWS account.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default ListXssMatchSetsResponse listXssMatchSets(Consumer<ListXssMatchSetsRequest.Builder> listXssMatchSetsRequest) throws WafInternalErrorException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
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 via ListXssMatchSetsRequest.builder()
listXssMatchSetsRequest
- A Consumer
that will call methods on ListXssMatchSetsRequest.Builder
to create a request.
A request to list the XssMatchSet objects created by the current AWS account.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.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default PutLoggingConfigurationResponse putLoggingConfiguration(PutLoggingConfigurationRequest putLoggingConfigurationRequest) throws WafInternalErrorException, WafNonexistentItemException, WafStaleDataException, WafServiceLinkedRoleErrorException, AwsServiceException, SdkClientException, WafException
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 .
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.
putLoggingConfigurationRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafServiceLinkedRoleErrorException
- AWS WAF is not able to access the service linked role. This can be caused by a previous
PutLoggingConfiguration
request, which can lock the service linked role for about 20
seconds. Please try your request again. The service linked role can also be locked by a previous
DeleteServiceLinkedRole
request, which can lock the role for 15 minutes or more. If you
recently made a DeleteServiceLinkedRole
, wait at least 15 minutes and try the request again.
If you receive this same exception again, you will have to wait additional time until the role is
unlocked.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default PutLoggingConfigurationResponse putLoggingConfiguration(Consumer<PutLoggingConfigurationRequest.Builder> putLoggingConfigurationRequest) throws WafInternalErrorException, WafNonexistentItemException, WafStaleDataException, WafServiceLinkedRoleErrorException, AwsServiceException, SdkClientException, WafException
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 .
Associate that firehose to your web ACL using a PutLoggingConfiguration
request.
When you successfully enable logging using a PutLoggingConfiguration
request, AWS WAF will create a
service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more
information, see Logging Web ACL
Traffic Information in the AWS WAF Developer Guide.
This is a convenience which creates an instance of the PutLoggingConfigurationRequest.Builder
avoiding
the need to create one manually via PutLoggingConfigurationRequest.builder()
putLoggingConfigurationRequest
- A Consumer
that will call methods on PutLoggingConfigurationRequest.Builder
to create a
request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafServiceLinkedRoleErrorException
- AWS WAF is not able to access the service linked role. This can be caused by a previous
PutLoggingConfiguration
request, which can lock the service linked role for about 20
seconds. Please try your request again. The service linked role can also be locked by a previous
DeleteServiceLinkedRole
request, which can lock the role for 15 minutes or more. If you
recently made a DeleteServiceLinkedRole
, wait at least 15 minutes and try the request again.
If you receive this same exception again, you will have to wait additional time until the role is
unlocked.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default PutPermissionPolicyResponse putPermissionPolicy(PutPermissionPolicyRequest putPermissionPolicyRequest) throws WafInternalErrorException, WafStaleDataException, WafNonexistentItemException, WafInvalidPermissionPolicyException, AwsServiceException, SdkClientException, WafException
Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.
The PutPermissionPolicy
is subject to the following restrictions:
You can attach only one policy with each PutPermissionPolicy
request.
The policy must include an Effect
, Action
and Principal
.
Effect
must specify Allow
.
The Action
in the policy must be waf:UpdateWebACL
,
waf-regional:UpdateWebACL
, waf:GetRuleGroup
and waf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected.
The policy cannot include a Resource
parameter.
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
The user making the request must be the owner of the RuleGroup.
Your policy must be composed using IAM Policy version 2012-10-17.
For more information, see IAM Policies.
An example of a valid policy parameter is shown in the Examples section below.
putPermissionPolicyRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidPermissionPolicyException
- The operation failed because the specified policy is not in the proper format.
The policy is subject to the following restrictions:
You can attach only one policy with each PutPermissionPolicy
request.
The policy must include an Effect
, Action
and Principal
.
Effect
must specify Allow
.
The Action
in the policy must be waf:UpdateWebACL
,
waf-regional:UpdateWebACL
, waf:GetRuleGroup
and
waf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected.
The policy cannot include a Resource
parameter.
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
The user making the request must be the owner of the RuleGroup.
Your policy must be composed using IAM Policy version 2012-10-17.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default PutPermissionPolicyResponse putPermissionPolicy(Consumer<PutPermissionPolicyRequest.Builder> putPermissionPolicyRequest) throws WafInternalErrorException, WafStaleDataException, WafNonexistentItemException, WafInvalidPermissionPolicyException, AwsServiceException, SdkClientException, WafException
Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.
The PutPermissionPolicy
is subject to the following restrictions:
You can attach only one policy with each PutPermissionPolicy
request.
The policy must include an Effect
, Action
and Principal
.
Effect
must specify Allow
.
The Action
in the policy must be waf:UpdateWebACL
,
waf-regional:UpdateWebACL
, waf:GetRuleGroup
and waf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected.
The policy cannot include a Resource
parameter.
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
The user making the request must be the owner of the RuleGroup.
Your policy must be composed using IAM Policy version 2012-10-17.
For more information, see IAM Policies.
An example of a valid policy parameter is shown in the Examples section below.
This is a convenience which creates an instance of the PutPermissionPolicyRequest.Builder
avoiding the
need to create one manually via PutPermissionPolicyRequest.builder()
putPermissionPolicyRequest
- A Consumer
that will call methods on PutPermissionPolicyRequest.Builder
to create a
request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidPermissionPolicyException
- The operation failed because the specified policy is not in the proper format.
The policy is subject to the following restrictions:
You can attach only one policy with each PutPermissionPolicy
request.
The policy must include an Effect
, Action
and Principal
.
Effect
must specify Allow
.
The Action
in the policy must be waf:UpdateWebACL
,
waf-regional:UpdateWebACL
, waf:GetRuleGroup
and
waf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected.
The policy cannot include a Resource
parameter.
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
The user making the request must be the owner of the RuleGroup.
Your policy must be composed using IAM Policy version 2012-10-17.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateByteMatchSetResponse updateByteMatchSet(UpdateByteMatchSetRequest updateByteMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each
ByteMatchTuple
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate
object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
User-Agent
header.
The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more
information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see
TargetString
in the ByteMatchTuple data type.
Where to look, such as at the beginning or the end of a query string.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can add a ByteMatchSetUpdate
object that matches web requests in which
User-Agent
headers contain the string BadBot
. You can then configure AWS WAF to block
those requests.
To create and configure a ByteMatchSet
, perform the following steps:
Create a ByteMatchSet.
For more information, see CreateByteMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of
an UpdateByteMatchSet
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.
updateByteMatchSetRequest
- WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateByteMatchSetResponse updateByteMatchSet(Consumer<UpdateByteMatchSetRequest.Builder> updateByteMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each
ByteMatchTuple
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate
object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
User-Agent
header.
The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more
information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see
TargetString
in the ByteMatchTuple data type.
Where to look, such as at the beginning or the end of a query string.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can add a ByteMatchSetUpdate
object that matches web requests in which
User-Agent
headers contain the string BadBot
. You can then configure AWS WAF to block
those requests.
To create and configure a ByteMatchSet
, perform the following steps:
Create a ByteMatchSet.
For more information, see CreateByteMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of
an UpdateByteMatchSet
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 via UpdateByteMatchSetRequest.builder()
updateByteMatchSetRequest
- A Consumer
that will call methods on UpdateByteMatchSetRequest.Builder
to create a
request.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateGeoMatchSetResponse updateGeoMatchSet(UpdateGeoMatchSetRequest updateGeoMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafReferencedItemException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet
. For each
GeoMatchConstraint
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint
object, you delete the existing object and add a new one.
The Type
. The only valid value for Type
is Country
.
The Value
, which is a two character code for the country to add to the
GeoMatchConstraint
object. Valid codes are listed in GeoMatchConstraint$Value.
To create and configure an GeoMatchSet
, perform the following steps:
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.
updateGeoMatchSetRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateGeoMatchSetResponse updateGeoMatchSet(Consumer<UpdateGeoMatchSetRequest.Builder> updateGeoMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafReferencedItemException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet
. For each
GeoMatchConstraint
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint
object, you delete the existing object and add a new one.
The Type
. The only valid value for Type
is Country
.
The Value
, which is a two character code for the country to add to the
GeoMatchConstraint
object. Valid codes are listed in GeoMatchConstraint$Value.
To create and configure an GeoMatchSet
, perform the following steps:
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 via UpdateGeoMatchSetRequest.builder()
updateGeoMatchSetRequest
- A Consumer
that will call methods on UpdateGeoMatchSetRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateIpSetResponse updateIPSet(UpdateIpSetRequest updateIpSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafReferencedItemException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes IPSetDescriptor objects in an IPSet
. For each IPSetDescriptor
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor
object, you delete the existing object and add a new one.
The IP address version, IPv4
or IPv6
.
The IP address in CIDR notation, for example, 192.0.2.0/24
(for the range of IP addresses from
192.0.2.0
to 192.0.2.255
) or 192.0.2.44/32
(for the individual IP address
192.0.2.44
).
AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /16, /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
IPv6 addresses can be represented using any of the following formats:
1111:0000:0000:0000:0000:0000:0000:0111/128
1111:0:0:0:0:0:0:0111/128
1111::0111/128
1111::111/128
You use an IPSet
to specify which web requests you want to allow or block based on the IP addresses
that the requests originated from. For example, if you're receiving a lot of requests from one or a small number
of IP addresses and you want to block the requests, you can create an IPSet
that specifies those IP
addresses, and then configure AWS WAF to block the requests.
To create and configure an IPSet
, perform the following steps:
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.
updateIpSetRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateIpSetResponse updateIPSet(Consumer<UpdateIpSetRequest.Builder> updateIpSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafReferencedItemException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes IPSetDescriptor objects in an IPSet
. For each IPSetDescriptor
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor
object, you delete the existing object and add a new one.
The IP address version, IPv4
or IPv6
.
The IP address in CIDR notation, for example, 192.0.2.0/24
(for the range of IP addresses from
192.0.2.0
to 192.0.2.255
) or 192.0.2.44/32
(for the individual IP address
192.0.2.44
).
AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /16, /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
IPv6 addresses can be represented using any of the following formats:
1111:0000:0000:0000:0000:0000:0000:0111/128
1111:0:0:0:0:0:0:0111/128
1111::0111/128
1111::111/128
You use an IPSet
to specify which web requests you want to allow or block based on the IP addresses
that the requests originated from. For example, if you're receiving a lot of requests from one or a small number
of IP addresses and you want to block the requests, you can create an IPSet
that specifies those IP
addresses, and then configure AWS WAF to block the requests.
To create and configure an IPSet
, perform the following steps:
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 via UpdateIpSetRequest.builder()
updateIpSetRequest
- A Consumer
that will call methods on UpdateIPSetRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateRateBasedRuleResponse updateRateBasedRule(UpdateRateBasedRuleRequest updateRateBasedRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafReferencedItemException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes Predicate objects in a rule and updates the RateLimit
in the rule.
Each Predicate
object identifies a predicate, such as a ByteMatchSet or an IPSet, that
specifies the web requests that you want to block or count. The RateLimit
specifies the number of
requests every five minutes that triggers the rule.
If you add more than one predicate to a RateBasedRule
, a request must match all the predicates and
exceed the RateLimit
to be counted or blocked. For example, suppose you add the following to a
RateBasedRule
:
An IPSet
that matches the IP address 192.0.2.44/32
A ByteMatchSet
that matches BadBot
in the User-Agent
header
Further, you specify a RateLimit
of 15,000.
You then add the RateBasedRule
to a WebACL
and specify that you want to block requests
that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the
User-Agent
header in the request must contain the value BadBot
. Further, requests that
match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops
below this limit, AWS WAF no longer blocks the requests.
As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could
add the following to a RateBasedRule
:
A ByteMatchSet
with FieldToMatch
of URI
A PositionalConstraint
of STARTS_WITH
A TargetString
of login
Further, you specify a RateLimit
of 15,000.
By adding this RateBasedRule
to a WebACL
, you could limit requests to your login page
without affecting the rest of your site.
updateRateBasedRuleRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateRateBasedRuleResponse updateRateBasedRule(Consumer<UpdateRateBasedRuleRequest.Builder> updateRateBasedRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafReferencedItemException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes Predicate objects in a rule and updates the RateLimit
in the rule.
Each Predicate
object identifies a predicate, such as a ByteMatchSet or an IPSet, that
specifies the web requests that you want to block or count. The RateLimit
specifies the number of
requests every five minutes that triggers the rule.
If you add more than one predicate to a RateBasedRule
, a request must match all the predicates and
exceed the RateLimit
to be counted or blocked. For example, suppose you add the following to a
RateBasedRule
:
An IPSet
that matches the IP address 192.0.2.44/32
A ByteMatchSet
that matches BadBot
in the User-Agent
header
Further, you specify a RateLimit
of 15,000.
You then add the RateBasedRule
to a WebACL
and specify that you want to block requests
that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the
User-Agent
header in the request must contain the value BadBot
. Further, requests that
match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops
below this limit, AWS WAF no longer blocks the requests.
As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could
add the following to a RateBasedRule
:
A ByteMatchSet
with FieldToMatch
of URI
A PositionalConstraint
of STARTS_WITH
A TargetString
of login
Further, you specify a RateLimit
of 15,000.
By adding this RateBasedRule
to a WebACL
, you could limit requests to your login page
without affecting the rest of your site.
This is a convenience which creates an instance of the UpdateRateBasedRuleRequest.Builder
avoiding the
need to create one manually via UpdateRateBasedRuleRequest.builder()
updateRateBasedRuleRequest
- A Consumer
that will call methods on UpdateRateBasedRuleRequest.Builder
to create a
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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateRegexMatchSetResponse updateRegexMatchSet(UpdateRegexMatchSetRequest updateRegexMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, WafNonexistentItemException, WafNonexistentContainerException, WafInvalidOperationException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each
RegexMatchSetUpdate
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate
object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the
User-Agent
header.
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can create a RegexPatternSet
that matches any requests with User-Agent
headers that contain the string B[a@]dB[o0]t
. You can then configure AWS WAF to reject those
requests.
To create and configure a RegexMatchSet
, perform the following steps:
Create a RegexMatchSet.
For more information, see CreateRegexMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of
an UpdateRegexMatchSet
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 the RegexPatternSet
that contain
the regular expression patters you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateRegexMatchSetRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafDisallowedNameException
- The name specified is invalid.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateRegexMatchSetResponse updateRegexMatchSet(Consumer<UpdateRegexMatchSetRequest.Builder> updateRegexMatchSetRequest) throws WafStaleDataException, WafInternalErrorException, WafDisallowedNameException, WafLimitsExceededException, WafNonexistentItemException, WafNonexistentContainerException, WafInvalidOperationException, WafInvalidAccountException, AwsServiceException, SdkClientException, WafException
Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each
RegexMatchSetUpdate
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate
object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the
User-Agent
header.
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can create a RegexPatternSet
that matches any requests with User-Agent
headers that contain the string B[a@]dB[o0]t
. You can then configure AWS WAF to reject those
requests.
To create and configure a RegexMatchSet
, perform the following steps:
Create a RegexMatchSet.
For more information, see CreateRegexMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of
an UpdateRegexMatchSet
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 the RegexPatternSet
that contain
the regular expression patters you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the UpdateRegexMatchSetRequest.Builder
avoiding the
need to create one manually via UpdateRegexMatchSetRequest.builder()
updateRegexMatchSetRequest
- A Consumer
that will call methods on UpdateRegexMatchSetRequest.Builder
to create a
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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafDisallowedNameException
- The name specified is invalid.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateRegexPatternSetResponse updateRegexPatternSet(UpdateRegexPatternSetRequest updateRegexPatternSetRequest) throws WafStaleDataException, WafInternalErrorException, WafLimitsExceededException, WafNonexistentItemException, WafNonexistentContainerException, WafInvalidOperationException, WafInvalidAccountException, WafInvalidRegexPatternException, AwsServiceException, SdkClientException, WafException
Inserts or deletes RegexPatternString
objects in a RegexPatternSet. For each
RegexPatternString
object, you specify the following values:
Whether to insert or delete the RegexPatternString
.
The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.
For example, you can create a RegexPatternString
such as B[a@]dB[o0]t
. AWS WAF will
match this RegexPatternString
to:
BadBot
BadB0t
B@dBot
B@dB0t
To create and configure a RegexPatternSet
, perform the following steps:
Create a RegexPatternSet.
For more information, see CreateRegexPatternSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of
an UpdateRegexPatternSet
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.
updateRegexPatternSetRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidRegexPatternException
- The regular expression (regex) you specified in RegexPatternString
is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateRegexPatternSetResponse updateRegexPatternSet(Consumer<UpdateRegexPatternSetRequest.Builder> updateRegexPatternSetRequest) throws WafStaleDataException, WafInternalErrorException, WafLimitsExceededException, WafNonexistentItemException, WafNonexistentContainerException, WafInvalidOperationException, WafInvalidAccountException, WafInvalidRegexPatternException, AwsServiceException, SdkClientException, WafException
Inserts or deletes RegexPatternString
objects in a RegexPatternSet. For each
RegexPatternString
object, you specify the following values:
Whether to insert or delete the RegexPatternString
.
The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.
For example, you can create a RegexPatternString
such as B[a@]dB[o0]t
. AWS WAF will
match this RegexPatternString
to:
BadBot
BadB0t
B@dBot
B@dB0t
To create and configure a RegexPatternSet
, perform the following steps:
Create a RegexPatternSet.
For more information, see CreateRegexPatternSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of
an UpdateRegexPatternSet
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 via UpdateRegexPatternSetRequest.builder()
updateRegexPatternSetRequest
- A Consumer
that will call methods on UpdateRegexPatternSetRequest.Builder
to create a
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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidRegexPatternException
- The regular expression (regex) you specified in RegexPatternString
is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateRuleResponse updateRule(UpdateRuleRequest updateRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafReferencedItemException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes Predicate objects in a Rule
. Each Predicate
object identifies
a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to
allow, block, or count. If you add more than one predicate to a Rule
, a request must match all of
the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a
Rule
:
A ByteMatchSet
that matches the value BadBot
in the User-Agent
header
An IPSet
that matches the IP address 192.0.2.44
You then add the Rule
to a WebACL
and specify that you want to block requests that
satisfy the Rule
. For a request to be blocked, the User-Agent
header in the request
must contain the value BadBot
and the request must originate from the IP address 192.0.2.44.
To create and configure a Rule
, perform the following steps:
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 the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRule
request to add predicates to the Rule
.
Create and update a WebACL
that contains the Rule
. See CreateWebACL.
If you want to replace one ByteMatchSet
or IPSet
with another, you delete the existing
one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateRuleRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateRuleResponse updateRule(Consumer<UpdateRuleRequest.Builder> updateRuleRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafReferencedItemException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes Predicate objects in a Rule
. Each Predicate
object identifies
a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to
allow, block, or count. If you add more than one predicate to a Rule
, a request must match all of
the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a
Rule
:
A ByteMatchSet
that matches the value BadBot
in the User-Agent
header
An IPSet
that matches the IP address 192.0.2.44
You then add the Rule
to a WebACL
and specify that you want to block requests that
satisfy the Rule
. For a request to be blocked, the User-Agent
header in the request
must contain the value BadBot
and the request must originate from the IP address 192.0.2.44.
To create and configure a Rule
, perform the following steps:
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 the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRule
request to add predicates to the Rule
.
Create and update a WebACL
that contains the Rule
. See CreateWebACL.
If you want to replace one ByteMatchSet
or IPSet
with another, you delete the existing
one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the UpdateRuleRequest.Builder
avoiding the need to
create one manually via UpdateRuleRequest.builder()
updateRuleRequest
- A Consumer
that will call methods on UpdateRuleRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateRuleGroupResponse updateRuleGroup(UpdateRuleGroupRequest updateRuleGroupRequest) throws WafStaleDataException, WafInternalErrorException, WafNonexistentContainerException, WafNonexistentItemException, WafInvalidOperationException, WafLimitsExceededException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
Inserts or deletes ActivatedRule objects in a RuleGroup
.
You can only insert REGULAR
rules into a rule group.
You can have a maximum of ten rules per rule group.
To create and configure a RuleGroup
, perform the following steps:
Create and update the Rules
that you want to include in the RuleGroup
. See
CreateRule.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRuleGroup request.
Submit an UpdateRuleGroup
request to add Rules
to the RuleGroup
.
Create and update a WebACL
that contains the RuleGroup
. See CreateWebACL.
If you want to replace one Rule
with another, you delete the existing one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateRuleGroupRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateRuleGroupResponse updateRuleGroup(Consumer<UpdateRuleGroupRequest.Builder> updateRuleGroupRequest) throws WafStaleDataException, WafInternalErrorException, WafNonexistentContainerException, WafNonexistentItemException, WafInvalidOperationException, WafLimitsExceededException, WafInvalidParameterException, AwsServiceException, SdkClientException, WafException
Inserts or deletes ActivatedRule objects in a RuleGroup
.
You can only insert REGULAR
rules into a rule group.
You can have a maximum of ten rules per rule group.
To create and configure a RuleGroup
, perform the following steps:
Create and update the Rules
that you want to include in the RuleGroup
. See
CreateRule.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRuleGroup request.
Submit an UpdateRuleGroup
request to add Rules
to the RuleGroup
.
Create and update a WebACL
that contains the RuleGroup
. See CreateWebACL.
If you want to replace one Rule
with another, you delete the existing one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the UpdateRuleGroupRequest.Builder
avoiding the need
to create one manually via UpdateRuleGroupRequest.builder()
updateRuleGroupRequest
- A Consumer
that will call methods on UpdateRuleGroupRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateSizeConstraintSetResponse updateSizeConstraintSet(UpdateSizeConstraintSetRequest updateSizeConstraintSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafReferencedItemException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each
SizeConstraint
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a
SizeConstraintSetUpdate
object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length
of the User-Agent
header.
Whether to perform any transformations on the request, such as converting it to lowercase, before checking its
length. Note that transformations of the request body are not supported because the AWS resource forwards only
the first 8192
bytes of your request to AWS WAF.
You can only specify a single type of TextTransformation.
A ComparisonOperator
used for evaluating the selected part of the request against the specified
Size
, such as equals, greater than, less than, and so on.
The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.
For example, you can add a SizeConstraintSetUpdate
object that matches web requests in which the
length of the User-Agent
header is greater than 100 bytes. You can then configure AWS WAF to block
those requests.
To create and configure a SizeConstraintSet
, perform the following steps:
Create a SizeConstraintSet.
For more information, see CreateSizeConstraintSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of
an UpdateSizeConstraintSet
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.
updateSizeConstraintSetRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateSizeConstraintSetResponse updateSizeConstraintSet(Consumer<UpdateSizeConstraintSetRequest.Builder> updateSizeConstraintSetRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafReferencedItemException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each
SizeConstraint
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a
SizeConstraintSetUpdate
object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length
of the User-Agent
header.
Whether to perform any transformations on the request, such as converting it to lowercase, before checking its
length. Note that transformations of the request body are not supported because the AWS resource forwards only
the first 8192
bytes of your request to AWS WAF.
You can only specify a single type of TextTransformation.
A ComparisonOperator
used for evaluating the selected part of the request against the specified
Size
, such as equals, greater than, less than, and so on.
The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.
For example, you can add a SizeConstraintSetUpdate
object that matches web requests in which the
length of the User-Agent
header is greater than 100 bytes. You can then configure AWS WAF to block
those requests.
To create and configure a SizeConstraintSet
, perform the following steps:
Create a SizeConstraintSet.
For more information, see CreateSizeConstraintSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of
an UpdateSizeConstraintSet
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 via UpdateSizeConstraintSetRequest.builder()
updateSizeConstraintSetRequest
- A Consumer
that will call methods on UpdateSizeConstraintSetRequest.Builder
to create a
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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateSqlInjectionMatchSetResponse updateSqlInjectionMatchSet(UpdateSqlInjectionMatchSetRequest updateSqlInjectionMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each
SqlInjectionMatchTuple
object, you specify the following values:
Action
: Whether to insert the object into or delete the object from the array. To change a
SqlInjectionMatchTuple
, you delete the existing object and add a new one.
FieldToMatch
: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to
inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation
: Which text transformation, if any, to perform on the web request before
inspecting the request for snippets of malicious SQL code.
You can only specify a single type of TextTransformation.
You use SqlInjectionMatchSet
objects to specify which CloudFront requests you want to allow, block,
or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you
want to block the requests, you can create a SqlInjectionMatchSet
with the applicable settings, and
then configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet
, perform the following steps:
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.
updateSqlInjectionMatchSetRequest
- A request to update a SqlInjectionMatchSet.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateSqlInjectionMatchSetResponse updateSqlInjectionMatchSet(Consumer<UpdateSqlInjectionMatchSetRequest.Builder> updateSqlInjectionMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each
SqlInjectionMatchTuple
object, you specify the following values:
Action
: Whether to insert the object into or delete the object from the array. To change a
SqlInjectionMatchTuple
, you delete the existing object and add a new one.
FieldToMatch
: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to
inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation
: Which text transformation, if any, to perform on the web request before
inspecting the request for snippets of malicious SQL code.
You can only specify a single type of TextTransformation.
You use SqlInjectionMatchSet
objects to specify which CloudFront requests you want to allow, block,
or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you
want to block the requests, you can create a SqlInjectionMatchSet
with the applicable settings, and
then configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet
, perform the following steps:
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 via UpdateSqlInjectionMatchSetRequest.builder()
updateSqlInjectionMatchSetRequest
- A Consumer
that will call methods on UpdateSqlInjectionMatchSetRequest.Builder
to create a
request. A request to update a SqlInjectionMatchSet.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateWebAclResponse updateWebACL(UpdateWebAclRequest updateWebAclRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafReferencedItemException, WafLimitsExceededException, WafSubscriptionNotFoundException, AwsServiceException, SdkClientException, WafException
Inserts or deletes ActivatedRule objects in a WebACL
. Each Rule
identifies web
requests that you want to allow, block, or count. When you update a WebACL
, you specify the
following values:
A default action for the WebACL
, either ALLOW
or BLOCK
. AWS WAF performs
the default action if a request doesn't match the criteria in any of the Rules
in a
WebACL
.
The Rules
that you want to add and/or delete. If you want to replace one Rule
with
another, you delete the existing Rule
and add the new one.
For each Rule
, whether you want AWS WAF to allow requests, block requests, or count requests that
match the conditions in the Rule
.
The order in which you want AWS WAF to evaluate the Rules
in a WebACL
. If you add more
than one Rule
to a WebACL
, AWS WAF evaluates each request against the
Rules
in order based on the value of Priority
. (The Rule
that has the
lowest value for Priority
is evaluated first.) When a web request matches all of the predicates
(such as ByteMatchSets
and IPSets
) in a Rule
, AWS WAF immediately takes
the corresponding action, allow or block, and doesn't evaluate the request against the remaining
Rules
in the WebACL
, if any.
To create and configure a WebACL
, perform the following steps:
Create and update the predicates that you want to include in Rules
. For more information, see
CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet,
CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules
that you want to include in the WebACL
. For more
information, see CreateRule and UpdateRule.
Create a WebACL
. See CreateWebACL.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateWebACL request.
Submit an UpdateWebACL
request to specify the Rules
that you want to include in the
WebACL
, to specify the default action, and to associate the WebACL
with a CloudFront
distribution.
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.
updateWebAclRequest
- WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.WafSubscriptionNotFoundException
- The specified subscription does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateWebAclResponse updateWebACL(Consumer<UpdateWebAclRequest.Builder> updateWebAclRequest) throws WafStaleDataException, WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafReferencedItemException, WafLimitsExceededException, WafSubscriptionNotFoundException, AwsServiceException, SdkClientException, WafException
Inserts or deletes ActivatedRule objects in a WebACL
. Each Rule
identifies web
requests that you want to allow, block, or count. When you update a WebACL
, you specify the
following values:
A default action for the WebACL
, either ALLOW
or BLOCK
. AWS WAF performs
the default action if a request doesn't match the criteria in any of the Rules
in a
WebACL
.
The Rules
that you want to add and/or delete. If you want to replace one Rule
with
another, you delete the existing Rule
and add the new one.
For each Rule
, whether you want AWS WAF to allow requests, block requests, or count requests that
match the conditions in the Rule
.
The order in which you want AWS WAF to evaluate the Rules
in a WebACL
. If you add more
than one Rule
to a WebACL
, AWS WAF evaluates each request against the
Rules
in order based on the value of Priority
. (The Rule
that has the
lowest value for Priority
is evaluated first.) When a web request matches all of the predicates
(such as ByteMatchSets
and IPSets
) in a Rule
, AWS WAF immediately takes
the corresponding action, allow or block, and doesn't evaluate the request against the remaining
Rules
in the WebACL
, if any.
To create and configure a WebACL
, perform the following steps:
Create and update the predicates that you want to include in Rules
. For more information, see
CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet,
CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules
that you want to include in the WebACL
. For more
information, see CreateRule and UpdateRule.
Create a WebACL
. See CreateWebACL.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateWebACL request.
Submit an UpdateWebACL
request to specify the Rules
that you want to include in the
WebACL
, to specify the default action, and to associate the WebACL
with a CloudFront
distribution.
Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
This is a convenience which creates an instance of the UpdateWebAclRequest.Builder
avoiding the need to
create one manually via UpdateWebAclRequest.builder()
updateWebAclRequest
- A Consumer
that will call methods on UpdateWebACLRequest.Builder
to create a 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.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafReferencedItemException
- The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.WafSubscriptionNotFoundException
- The specified subscription does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateXssMatchSetResponse updateXssMatchSet(UpdateXssMatchSetRequest updateXssMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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 a
XssMatchTuple
, you delete the existing object and add a new one.
FieldToMatch
: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to
inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation
: Which text transformation, if any, to perform on the web request before
inspecting the request for cross-site scripting attacks.
You can only specify a single type of TextTransformation.
You use XssMatchSet
objects to specify which CloudFront requests you want to allow, block, or count.
For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you
want to block the requests, you can create an XssMatchSet
with the applicable settings, and then
configure AWS WAF to block the requests.
To create and configure an XssMatchSet
, perform the following steps:
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.
updateXssMatchSetRequest
- A request to update an XssMatchSet.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
default UpdateXssMatchSetResponse updateXssMatchSet(Consumer<UpdateXssMatchSetRequest.Builder> updateXssMatchSetRequest) throws WafInternalErrorException, WafInvalidAccountException, WafInvalidOperationException, WafInvalidParameterException, WafNonexistentContainerException, WafNonexistentItemException, WafStaleDataException, WafLimitsExceededException, AwsServiceException, SdkClientException, WafException
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 a
XssMatchTuple
, you delete the existing object and add a new one.
FieldToMatch
: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to
inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation
: Which text transformation, if any, to perform on the web request before
inspecting the request for cross-site scripting attacks.
You can only specify a single type of TextTransformation.
You use XssMatchSet
objects to specify which CloudFront requests you want to allow, block, or count.
For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you
want to block the requests, you can create an XssMatchSet
with the applicable settings, and then
configure AWS WAF to block the requests.
To create and configure an XssMatchSet
, perform the following steps:
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 via UpdateXssMatchSetRequest.builder()
updateXssMatchSetRequest
- A Consumer
that will call methods on UpdateXssMatchSetRequest.Builder
to create a request.
A request to update an XssMatchSet.WafInternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.WafInvalidAccountException
- The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WafInvalidOperationException
- The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in
the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified
IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the
ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists
in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the
ByteMatchTuple
already exists in the specified WebACL
.
WafInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or
WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than
IP
.
You tried to update a WebACL
with a WafAction
Type
other than
ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no
value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WafNonexistentContainerException
- The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that
doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a
Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a
ByteMatchSet
that doesn't exist.
WafNonexistentItemException
- The operation failed because the referenced object doesn't exist.WafStaleDataException
- The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WafLimitsExceededException
- The operation exceeds a resource limit, for example, the maximum number of WebACL
objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.WafRegionalException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
WafException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.