@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSWAFV2Client extends AmazonWebServiceClient implements AWSWAFV2
This is the latest version of the AWS WAF API, released in November, 2019. The names of the entities that you
use to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2",
to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number
of significant improvements.
If you used AWS WAF prior to this release, you can't use this AWS WAFV2 API to access any AWS WAF resources that you
created before. You can access your old rules, web ACLs, and other AWS WAF resources only through the AWS WAF Classic
APIs. The AWS WAF Classic APIs have retained the prior names, endpoints, and namespaces.
For information, including how to migrate your AWS WAF resources to this version, see the AWS WAF Developer Guide.
AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer. AWS WAF also lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, API Gateway, CloudFront, or the Application Load Balancer responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You also can configure CloudFront to return a custom error page when a request is blocked.
This API guide is for developers who need detailed information about AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use AWS WAF, see the AWS WAF Developer Guide.
You can make API calls using the endpoints listed in AWS Service Endpoints for AWS WAF.
For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
For AWS CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.
Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
We currently provide two versions of the AWS WAF API: this API and the prior versions, the classic AWS WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:
You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a
Scope
parameter and set it to CLOUDFRONT
or REGIONAL
.
You can define a Web ACL or rule group with a single API call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or Web ACL API calls.
The limits AWS WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSWAFV2ClientBuilder builder()
public AssociateWebACLResult associateWebACL(AssociateWebACLRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
For AWS CloudFront, you can associate the Web ACL by providing the Id
of the WebACL to the
CloudFront API call UpdateDistribution
. For information, see UpdateDistribution.
associateWebACL
in interface AWSWAFV2
associateWebACLRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFUnavailableEntityException
- AWS WAF couldn’t retrieve the resource that you requested. Retry your request.public CheckCapacityResult checkCapacity(CheckCapacityRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
checkCapacity
in interface AWSWAFV2
checkCapacityRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFLimitsExceededException
- AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an AWS account. For more information, see
Limits in the AWS WAF
Developer Guide.WAFInvalidResourceException
- AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the
resource, and try again.WAFUnavailableEntityException
- AWS WAF couldn’t retrieve the resource that you requested. Retry your request.public CreateIPSetResult createIPSet(CreateIPSetRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IPSet that lists those IP addresses.
createIPSet
in interface AWSWAFV2
createIPSetRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFDuplicateItemException
- AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFLimitsExceededException
- AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an AWS account. For more information, see
Limits in the AWS WAF
Developer Guide.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.public CreateRegexPatternSetResult createRegexPatternSet(CreateRegexPatternSetRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Creates a RegexPatternSet per the specifications provided.
createRegexPatternSet
in interface AWSWAFV2
createRegexPatternSetRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFDuplicateItemException
- AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFLimitsExceededException
- AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an AWS account. For more information, see
Limits in the AWS WAF
Developer Guide.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.public CreateRuleGroupResult createRuleGroup(CreateRuleGroupRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Creates a RuleGroup per the specifications provided.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
createRuleGroup
in interface AWSWAFV2
createRuleGroupRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFDuplicateItemException
- AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFLimitsExceededException
- AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an AWS account. For more information, see
Limits in the AWS WAF
Developer Guide.WAFUnavailableEntityException
- AWS WAF couldn’t retrieve the resource that you requested. Retry your request.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.public CreateWebACLResult createWebACL(CreateWebACLRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Creates a WebACL per the specifications provided.
A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer.
createWebACL
in interface AWSWAFV2
createWebACLRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFDuplicateItemException
- AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFLimitsExceededException
- AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an AWS account. For more information, see
Limits in the AWS WAF
Developer Guide.WAFInvalidResourceException
- AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the
resource, and try again.WAFUnavailableEntityException
- AWS WAF couldn’t retrieve the resource that you requested. Retry your request.WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.public DeleteIPSetResult deleteIPSet(DeleteIPSetRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Deletes the specified IPSet.
deleteIPSet
in interface AWSWAFV2
deleteIPSetRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.public DeleteLoggingConfigurationResult deleteLoggingConfiguration(DeleteLoggingConfigurationRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Deletes the LoggingConfiguration from the specified web ACL.
deleteLoggingConfiguration
in interface AWSWAFV2
deleteLoggingConfigurationRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.public DeleteRegexPatternSetResult deleteRegexPatternSet(DeleteRegexPatternSetRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Deletes the specified RegexPatternSet.
deleteRegexPatternSet
in interface AWSWAFV2
deleteRegexPatternSetRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.public DeleteRuleGroupResult deleteRuleGroup(DeleteRuleGroupRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Deletes the specified RuleGroup.
deleteRuleGroup
in interface AWSWAFV2
deleteRuleGroupRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.public DeleteWebACLResult deleteWebACL(DeleteWebACLRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Deletes the specified WebACL.
deleteWebACL
in interface AWSWAFV2
deleteWebACLRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFAssociatedItemException
- AWS WAF couldn’t perform the operation because your resource is being used by another resource or it’s
associated with another resource.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.public DescribeManagedRuleGroupResult describeManagedRuleGroup(DescribeManagedRuleGroupRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Provides high-level information for a managed rule group, including descriptions of the rules.
describeManagedRuleGroup
in interface AWSWAFV2
describeManagedRuleGroupRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFInvalidResourceException
- AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the
resource, and try again.WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.public DisassociateWebACLResult disassociateWebACL(DisassociateWebACLRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
For AWS CloudFront, you can disassociate the Web ACL by providing an empty WebACLId
in the
CloudFront API call UpdateDistribution
. For information, see UpdateDistribution.
disassociateWebACL
in interface AWSWAFV2
disassociateWebACLRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.public GetIPSetResult getIPSet(GetIPSetRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the specified IPSet.
getIPSet
in interface AWSWAFV2
getIPSetRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.public GetLoggingConfigurationResult getLoggingConfiguration(GetLoggingConfigurationRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Returns the LoggingConfiguration for the specified web ACL.
getLoggingConfiguration
in interface AWSWAFV2
getLoggingConfigurationRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.public GetRateBasedStatementManagedKeysResult getRateBasedStatementManagedKeys(GetRateBasedStatementManagedKeysRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the keys that are currently blocked by a rate-based rule. The maximum number of managed keys that can be blocked for a single rate-based rule is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.
getRateBasedStatementManagedKeys
in interface AWSWAFV2
getRateBasedStatementManagedKeysRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.public GetRegexPatternSetResult getRegexPatternSet(GetRegexPatternSetRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the specified RegexPatternSet.
getRegexPatternSet
in interface AWSWAFV2
getRegexPatternSetRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.public GetRuleGroupResult getRuleGroup(GetRuleGroupRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the specified RuleGroup.
getRuleGroup
in interface AWSWAFV2
getRuleGroupRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.public GetSampledRequestsResult getSampledRequests(GetSampledRequestsRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
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.
getSampledRequests
in interface AWSWAFV2
getSampledRequestsRequest
- WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
public GetWebACLResult getWebACL(GetWebACLRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the specified WebACL.
getWebACL
in interface AWSWAFV2
getWebACLRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.public GetWebACLForResourceResult getWebACLForResource(GetWebACLForResourceRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the WebACL for the specified resource.
getWebACLForResource
in interface AWSWAFV2
getWebACLForResourceRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource 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 or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFUnavailableEntityException
- AWS WAF couldn’t retrieve the resource that you requested. Retry your request.public ListAvailableManagedRuleGroupsResult listAvailableManagedRuleGroups(ListAvailableManagedRuleGroupsRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS managed rule groups and the AWS Marketplace managed rule groups that you're subscribed to.
listAvailableManagedRuleGroups
in interface AWSWAFV2
listAvailableManagedRuleGroupsRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
public ListIPSetsResult listIPSets(ListIPSetsRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of IPSetSummary objects for the IP sets that you manage.
listIPSets
in interface AWSWAFV2
listIPSetsRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
public ListLoggingConfigurationsResult listLoggingConfigurations(ListLoggingConfigurationsRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of your LoggingConfiguration objects.
listLoggingConfigurations
in interface AWSWAFV2
listLoggingConfigurationsRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
public ListRegexPatternSetsResult listRegexPatternSets(ListRegexPatternSetsRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
listRegexPatternSets
in interface AWSWAFV2
listRegexPatternSetsRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
public ListResourcesForWebACLResult listResourcesForWebACL(ListResourcesForWebACLRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the
specified web ACL. If you want the list of AWS CloudFront resources, use the AWS CloudFront call
ListDistributionsByWebACLId
.
listResourcesForWebACL
in interface AWSWAFV2
listResourcesForWebACLRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource 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 or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
public ListRuleGroupsResult listRuleGroups(ListRuleGroupsRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
listRuleGroups
in interface AWSWAFV2
listRuleGroupsRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves the TagInfoForResource for the specified resource.
listTagsForResource
in interface AWSWAFV2
listTagsForResourceRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.public ListWebACLsResult listWebACLs(ListWebACLsRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
listWebACLs
in interface AWSWAFV2
listWebACLsRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
public PutLoggingConfigurationResult putLoggingConfiguration(PutLoggingConfigurationRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
You can access information about all traffic that AWS WAF inspects using the following steps:
Create an Amazon Kinesis Data Firehose.
Create the data firehose with a PUT source and in the region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).
Do not create the data firehose using a Kinesis stream
as your source.
Associate that firehose to your web ACL using a PutLoggingConfiguration
request.
When you successfully enable logging using a PutLoggingConfiguration
request, AWS WAF will create a
service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more
information, see Logging Web ACL
Traffic Information in the AWS WAF Developer Guide.
putLoggingConfiguration
in interface AWSWAFV2
putLoggingConfigurationRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFServiceLinkedRoleErrorException
- 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 call to DeleteServiceLinkedRole
, wait at least 15 minutes and try the
request again. If you receive this same exception again, you will have to wait additional time until the
role is unlocked.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
public TagResourceResult tagResource(TagResourceRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Associates tags with the specified AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource.
tagResource
in interface AWSWAFV2
tagResourceRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFLimitsExceededException
- AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an AWS account. For more information, see
Limits in the AWS WAF
Developer Guide.WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.public UntagResourceResult untagResource(UntagResourceRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Disassociates tags from an AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource.
untagResource
in interface AWSWAFV2
untagResourceRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.public UpdateIPSetResult updateIPSet(UpdateIPSetRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Updates the specified IPSet.
updateIPSet
in interface AWSWAFV2
updateIPSetRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFDuplicateItemException
- AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFLimitsExceededException
- AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an AWS account. For more information, see
Limits in the AWS WAF
Developer Guide.public UpdateRegexPatternSetResult updateRegexPatternSet(UpdateRegexPatternSetRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Updates the specified RegexPatternSet.
updateRegexPatternSet
in interface AWSWAFV2
updateRegexPatternSetRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFDuplicateItemException
- AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFLimitsExceededException
- AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an AWS account. For more information, see
Limits in the AWS WAF
Developer Guide.public UpdateRuleGroupResult updateRuleGroup(UpdateRuleGroupRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Updates the specified RuleGroup.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
updateRuleGroup
in interface AWSWAFV2
updateRuleGroupRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFDuplicateItemException
- AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFLimitsExceededException
- AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an AWS account. For more information, see
Limits in the AWS WAF
Developer Guide.WAFUnavailableEntityException
- AWS WAF couldn’t retrieve the resource that you requested. Retry your request.public UpdateWebACLResult updateWebACL(UpdateWebACLRequest request)
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
Updates the specified WebACL.
A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer.
updateWebACL
in interface AWSWAFV2
updateWebACLRequest
- WAFInternalErrorException
- Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name or value.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
WAFNonexistentItemException
- AWS WAF couldn’t perform the operation because your resource doesn’t exist.WAFDuplicateItemException
- AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed
since you last retrieved it. Get the resource again, make any changes you need to make to the new copy,
and retry your operation.WAFLimitsExceededException
- AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an AWS account. For more information, see
Limits in the AWS WAF
Developer Guide.WAFInvalidResourceException
- AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the
resource, and try again.WAFUnavailableEntityException
- AWS WAF couldn’t retrieve the resource that you requested. Retry your request.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSWAFV2
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.