@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSWAFV2Client extends AmazonWebServiceClient implements AWSWAFV2
This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use
to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2", to
distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of
significant improvements.
If you used WAF prior to this release, you can't use this WAFV2 API to access any WAF resources that you created
before. You can access your old rules, web ACLs, and other WAF resources only through the WAF Classic APIs. The WAF
Classic APIs have retained the prior names, endpoints, and namespaces.
For information, including how to migrate your WAF resources to this version, see the WAF Developer Guide.
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API. 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, the Amazon API Gateway REST API, CloudFront distribution, the Application Load Balancer, or the AppSync GraphQL API 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 WAF API actions, data types, and errors. For detailed information about WAF features and an overview of how to use WAF, see the WAF Developer Guide.
You can make calls using the endpoints listed in WAF endpoints and quotas.
For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
For Amazon CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
We currently provide two versions of the WAF API: this API and the prior versions, the classic WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:
You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a
Scope
parameter and set it to CLOUDFRONT
or REGIONAL
.
You can define a web ACL or rule group with a single call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or web ACL calls.
The limits WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateWebACLResult |
associateWebACL(AssociateWebACLRequest request)
Associates a web ACL with a regional application resource, to protect the resource.
|
static AWSWAFV2ClientBuilder |
builder() |
CheckCapacityResult |
checkCapacity(CheckCapacityRequest request)
Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules.
|
CreateIPSetResult |
createIPSet(CreateIPSetRequest request)
Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or
ranges of IP addresses.
|
CreateRegexPatternSetResult |
createRegexPatternSet(CreateRegexPatternSetRequest request)
Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF
inspect a web request component for the specified patterns.
|
CreateRuleGroupResult |
createRuleGroup(CreateRuleGroupRequest request)
Creates a RuleGroup per the specifications provided.
|
CreateWebACLResult |
createWebACL(CreateWebACLRequest request)
Creates a WebACL per the specifications provided.
|
DeleteFirewallManagerRuleGroupsResult |
deleteFirewallManagerRuleGroups(DeleteFirewallManagerRuleGroupsRequest request)
Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.
|
DeleteIPSetResult |
deleteIPSet(DeleteIPSetRequest request)
Deletes the specified IPSet.
|
DeleteLoggingConfigurationResult |
deleteLoggingConfiguration(DeleteLoggingConfigurationRequest request)
Deletes the LoggingConfiguration from the specified web ACL.
|
DeletePermissionPolicyResult |
deletePermissionPolicy(DeletePermissionPolicyRequest request)
Permanently deletes an IAM policy from the specified rule group.
|
DeleteRegexPatternSetResult |
deleteRegexPatternSet(DeleteRegexPatternSetRequest request)
Deletes the specified RegexPatternSet.
|
DeleteRuleGroupResult |
deleteRuleGroup(DeleteRuleGroupRequest request)
Deletes the specified RuleGroup.
|
DeleteWebACLResult |
deleteWebACL(DeleteWebACLRequest request)
Deletes the specified WebACL.
|
DescribeManagedRuleGroupResult |
describeManagedRuleGroup(DescribeManagedRuleGroupRequest request)
Provides high-level information for a managed rule group, including descriptions of the rules.
|
DisassociateWebACLResult |
disassociateWebACL(DisassociateWebACLRequest request)
Disassociates a web ACL from a regional application resource.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetIPSetResult |
getIPSet(GetIPSetRequest request)
Retrieves the specified IPSet.
|
GetLoggingConfigurationResult |
getLoggingConfiguration(GetLoggingConfigurationRequest request)
Returns the LoggingConfiguration for the specified web ACL.
|
GetManagedRuleSetResult |
getManagedRuleSet(GetManagedRuleSetRequest request)
Retrieves the specified managed rule set.
|
GetPermissionPolicyResult |
getPermissionPolicy(GetPermissionPolicyRequest request)
Returns the IAM policy that is attached to the specified rule group.
|
GetRateBasedStatementManagedKeysResult |
getRateBasedStatementManagedKeys(GetRateBasedStatementManagedKeysRequest request)
Retrieves the keys that are currently blocked by a rate-based rule instance.
|
GetRegexPatternSetResult |
getRegexPatternSet(GetRegexPatternSetRequest request)
Retrieves the specified RegexPatternSet.
|
GetRuleGroupResult |
getRuleGroup(GetRuleGroupRequest request)
Retrieves the specified RuleGroup.
|
GetSampledRequestsResult |
getSampledRequests(GetSampledRequestsRequest request)
Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among
the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose.
|
GetWebACLResult |
getWebACL(GetWebACLRequest request)
Retrieves the specified WebACL.
|
GetWebACLForResourceResult |
getWebACLForResource(GetWebACLForResourceRequest request)
Retrieves the WebACL for the specified resource.
|
ListAvailableManagedRuleGroupsResult |
listAvailableManagedRuleGroups(ListAvailableManagedRuleGroupsRequest request)
Retrieves an array of managed rule groups that are available for you to use.
|
ListAvailableManagedRuleGroupVersionsResult |
listAvailableManagedRuleGroupVersions(ListAvailableManagedRuleGroupVersionsRequest request)
Returns a list of the available versions for the specified managed rule group.
|
ListIPSetsResult |
listIPSets(ListIPSetsRequest request)
Retrieves an array of IPSetSummary objects for the IP sets that you manage.
|
ListLoggingConfigurationsResult |
listLoggingConfigurations(ListLoggingConfigurationsRequest request)
Retrieves an array of your LoggingConfiguration objects.
|
ListManagedRuleSetsResult |
listManagedRuleSets(ListManagedRuleSetsRequest request)
Retrieves the managed rule sets that you own.
|
ListRegexPatternSetsResult |
listRegexPatternSets(ListRegexPatternSetsRequest request)
Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
|
ListResourcesForWebACLResult |
listResourcesForWebACL(ListResourcesForWebACLRequest request)
Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the
specified web ACL.
|
ListRuleGroupsResult |
listRuleGroups(ListRuleGroupsRequest request)
Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieves the TagInfoForResource for the specified resource.
|
ListWebACLsResult |
listWebACLs(ListWebACLsRequest request)
Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
|
PutLoggingConfigurationResult |
putLoggingConfiguration(PutLoggingConfigurationRequest request)
Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the
configuration provided.
|
PutManagedRuleSetVersionsResult |
putManagedRuleSetVersions(PutManagedRuleSetVersionsRequest request)
Defines the versions of your managed rule set that you are offering to the customers.
|
PutPermissionPolicyResult |
putPermissionPolicy(PutPermissionPolicyRequest request)
Attaches an IAM policy to the specified resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associates tags with the specified Amazon Web Services resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Disassociates tags from an Amazon Web Services resource.
|
UpdateIPSetResult |
updateIPSet(UpdateIPSetRequest request)
Updates the specified IPSet.
|
UpdateManagedRuleSetVersionExpiryDateResult |
updateManagedRuleSetVersionExpiryDate(UpdateManagedRuleSetVersionExpiryDateRequest request)
Updates the expiration information for your managed rule set.
|
UpdateRegexPatternSetResult |
updateRegexPatternSet(UpdateRegexPatternSetRequest request)
Updates the specified RegexPatternSet.
|
UpdateRuleGroupResult |
updateRuleGroup(UpdateRuleGroupRequest request)
Updates the specified RuleGroup.
|
UpdateWebACLResult |
updateWebACL(UpdateWebACLRequest request)
Updates the specified WebACL.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSWAFV2ClientBuilder builder()
public AssociateWebACLResult associateWebACL(AssociateWebACLRequest request)
Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate
a web ACL, in the CloudFront call UpdateDistribution
, set the web ACL ID to the Amazon Resource Name
(ARN) of the web ACL. For information, see UpdateDistribution.
associateWebACL
in interface AWSWAFV2
associateWebACLRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFUnavailableEntityException
- WAF couldn’t retrieve the resource that you requested. Retry your request.WAFInvalidOperationException
- The operation isn't valid.public CheckCapacityResult checkCapacity(CheckCapacityRequest request)
Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
checkCapacity
in interface AWSWAFV2
checkCapacityRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFLimitsExceededException
- WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an Amazon Web Services account. For more
information, see WAF
quotas in the WAF Developer Guide.WAFInvalidResourceException
- WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the
resource, and try again.WAFUnavailableEntityException
- WAF couldn’t retrieve the resource that you requested. Retry your request.WAFSubscriptionNotFoundException
- You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it
yet.WAFExpiredManagedRuleGroupVersionException
- The operation failed because the specified version for the managed rule group has expired. You can
retrieve the available versions for the managed rule group by calling
ListAvailableManagedRuleGroupVersions.public CreateIPSetResult createIPSet(CreateIPSetRequest request)
Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.
createIPSet
in interface AWSWAFV2
createIPSetRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFDuplicateItemException
- WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFLimitsExceededException
- WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an Amazon Web Services account. For more
information, see WAF
quotas in the WAF Developer Guide.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- WAF couldn’t perform your tagging operation because of an internal error. Retry your request.WAFInvalidOperationException
- The operation isn't valid.public CreateRegexPatternSetResult createRegexPatternSet(CreateRegexPatternSetRequest request)
Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.
createRegexPatternSet
in interface AWSWAFV2
createRegexPatternSetRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFDuplicateItemException
- WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFLimitsExceededException
- WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an Amazon Web Services account. For more
information, see WAF
quotas in the WAF Developer Guide.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- WAF couldn’t perform your tagging operation because of an internal error. Retry your request.WAFInvalidOperationException
- The operation isn't valid.public CreateRuleGroupResult createRuleGroup(CreateRuleGroupRequest request)
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 WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFDuplicateItemException
- WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFLimitsExceededException
- WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an Amazon Web Services account. For more
information, see WAF
quotas in the WAF Developer Guide.WAFUnavailableEntityException
- WAF couldn’t retrieve the resource that you requested. Retry your request.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- WAF couldn’t perform your tagging operation because of an internal error. Retry your request.WAFSubscriptionNotFoundException
- You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it
yet.WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInvalidOperationException
- The operation isn't valid.public CreateWebACLResult createWebACL(CreateWebACLRequest request)
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 Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.
createWebACL
in interface AWSWAFV2
createWebACLRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFDuplicateItemException
- WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFLimitsExceededException
- WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an Amazon Web Services account. For more
information, see WAF
quotas in the WAF Developer Guide.WAFInvalidResourceException
- WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the
resource, and try again.WAFUnavailableEntityException
- WAF couldn’t retrieve the resource that you requested. Retry your request.WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- WAF couldn’t perform your tagging operation because of an internal error. Retry your request.WAFSubscriptionNotFoundException
- You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it
yet.WAFInvalidOperationException
- The operation isn't valid.public DeleteFirewallManagerRuleGroupsResult deleteFirewallManagerRuleGroups(DeleteFirewallManagerRuleGroupsRequest request)
Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.
You can only use this if ManagedByFirewallManager
is false in the specified WebACL.
deleteFirewallManagerRuleGroups
in interface AWSWAFV2
deleteFirewallManagerRuleGroupsRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFInvalidOperationException
- The operation isn't valid.public DeleteIPSetResult deleteIPSet(DeleteIPSetRequest request)
Deletes the specified IPSet.
deleteIPSet
in interface AWSWAFV2
deleteIPSetRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFAssociatedItemException
- WAF couldn’t perform the operation because your resource is being used by another resource or it’s
associated with another resource.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- WAF couldn’t perform your tagging operation because of an internal error. Retry your request.WAFInvalidOperationException
- The operation isn't valid.public DeleteLoggingConfigurationResult deleteLoggingConfiguration(DeleteLoggingConfigurationRequest request)
Deletes the LoggingConfiguration from the specified web ACL.
deleteLoggingConfiguration
in interface AWSWAFV2
deleteLoggingConfigurationRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidOperationException
- The operation isn't valid.public DeletePermissionPolicyResult deletePermissionPolicy(DeletePermissionPolicyRequest request)
Permanently deletes an IAM policy from the specified rule group.
You must be the owner of the rule group to perform this operation.
deletePermissionPolicy
in interface AWSWAFV2
deletePermissionPolicyRequest
- WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
public DeleteRegexPatternSetResult deleteRegexPatternSet(DeleteRegexPatternSetRequest request)
Deletes the specified RegexPatternSet.
deleteRegexPatternSet
in interface AWSWAFV2
deleteRegexPatternSetRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFAssociatedItemException
- WAF couldn’t perform the operation because your resource is being used by another resource or it’s
associated with another resource.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- WAF couldn’t perform your tagging operation because of an internal error. Retry your request.WAFInvalidOperationException
- The operation isn't valid.public DeleteRuleGroupResult deleteRuleGroup(DeleteRuleGroupRequest request)
Deletes the specified RuleGroup.
deleteRuleGroup
in interface AWSWAFV2
deleteRuleGroupRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFAssociatedItemException
- WAF couldn’t perform the operation because your resource is being used by another resource or it’s
associated with another resource.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- WAF couldn’t perform your tagging operation because of an internal error. Retry your request.WAFInvalidOperationException
- The operation isn't valid.public DeleteWebACLResult deleteWebACL(DeleteWebACLRequest request)
Deletes the specified WebACL.
You can only use this if ManagedByFirewallManager
is false in the specified WebACL.
deleteWebACL
in interface AWSWAFV2
deleteWebACLRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFAssociatedItemException
- WAF couldn’t perform the operation because your resource is being used by another resource or it’s
associated with another resource.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- WAF couldn’t perform your tagging operation because of an internal error. Retry your request.WAFInvalidOperationException
- The operation isn't valid.public DescribeManagedRuleGroupResult describeManagedRuleGroup(DescribeManagedRuleGroupRequest request)
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 WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidResourceException
- WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the
resource, and try again.WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInvalidOperationException
- The operation isn't valid.WAFExpiredManagedRuleGroupVersionException
- The operation failed because the specified version for the managed rule group has expired. You can
retrieve the available versions for the managed rule group by calling
ListAvailableManagedRuleGroupVersions.public DisassociateWebACLResult disassociateWebACL(DisassociateWebACLRequest request)
Disassociates a web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To
disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution
. For
information, see
UpdateDistribution.
disassociateWebACL
in interface AWSWAFV2
disassociateWebACLRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInvalidOperationException
- The operation isn't valid.public GetIPSetResult getIPSet(GetIPSetRequest request)
Retrieves the specified IPSet.
getIPSet
in interface AWSWAFV2
getIPSetRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInvalidOperationException
- The operation isn't valid.public GetLoggingConfigurationResult getLoggingConfiguration(GetLoggingConfigurationRequest request)
Returns the LoggingConfiguration for the specified web ACL.
getLoggingConfiguration
in interface AWSWAFV2
getLoggingConfigurationRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidOperationException
- The operation isn't valid.public GetManagedRuleSetResult getManagedRuleSet(GetManagedRuleSetRequest request)
Retrieves the specified managed rule set.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group
offerings for your customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
,
PutManagedRuleSetVersions
, and UpdateManagedRuleSetVersionExpiryDate
.
getManagedRuleSet
in interface AWSWAFV2
getManagedRuleSetRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInvalidOperationException
- The operation isn't valid.public GetPermissionPolicyResult getPermissionPolicy(GetPermissionPolicyRequest request)
Returns the IAM policy that is attached to the specified rule group.
You must be the owner of the rule group to perform this operation.
getPermissionPolicy
in interface AWSWAFV2
getPermissionPolicyRequest
- WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
public GetRateBasedStatementManagedKeysResult getRateBasedStatementManagedKeys(GetRateBasedStatementManagedKeysRequest request)
Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.
For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.
WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
getRateBasedStatementManagedKeys
in interface AWSWAFV2
getRateBasedStatementManagedKeysRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInvalidOperationException
- The operation isn't valid.public GetRegexPatternSetResult getRegexPatternSet(GetRegexPatternSetRequest request)
Retrieves the specified RegexPatternSet.
getRegexPatternSet
in interface AWSWAFV2
getRegexPatternSetRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInvalidOperationException
- The operation isn't valid.public GetRuleGroupResult getRuleGroup(GetRuleGroupRequest request)
Retrieves the specified RuleGroup.
getRuleGroup
in interface AWSWAFV2
getRuleGroupRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInvalidOperationException
- The operation isn't valid.public GetSampledRequestsResult getSampledRequests(GetSampledRequestsRequest request)
Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.
GetSampledRequests
returns a time range, which is usually the time range that you specified.
However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time
range elapsed, GetSampledRequests
returns an updated time range. This new time range indicates the
actual period during which WAF selected the requests in the sample.
getSampledRequests
in interface AWSWAFV2
getSampledRequestsRequest
- WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
public GetWebACLResult getWebACL(GetWebACLRequest request)
Retrieves the specified WebACL.
getWebACL
in interface AWSWAFV2
getWebACLRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInvalidOperationException
- The operation isn't valid.public GetWebACLForResourceResult getWebACLForResource(GetWebACLForResourceRequest request)
Retrieves the WebACL for the specified resource.
getWebACLForResource
in interface AWSWAFV2
getWebACLForResourceRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFUnavailableEntityException
- WAF couldn’t retrieve the resource that you requested. Retry your request.WAFInvalidOperationException
- The operation isn't valid.public ListAvailableManagedRuleGroupVersionsResult listAvailableManagedRuleGroupVersions(ListAvailableManagedRuleGroupVersionsRequest request)
Returns a list of the available versions for the specified managed rule group.
listAvailableManagedRuleGroupVersions
in interface AWSWAFV2
listAvailableManagedRuleGroupVersionsRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidOperationException
- The operation isn't valid.public ListAvailableManagedRuleGroupsResult listAvailableManagedRuleGroups(ListAvailableManagedRuleGroupsRequest request)
Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.
listAvailableManagedRuleGroups
in interface AWSWAFV2
listAvailableManagedRuleGroupsRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidOperationException
- The operation isn't valid.public ListIPSetsResult listIPSets(ListIPSetsRequest request)
Retrieves an array of IPSetSummary objects for the IP sets that you manage.
listIPSets
in interface AWSWAFV2
listIPSetsRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidOperationException
- The operation isn't valid.public ListLoggingConfigurationsResult listLoggingConfigurations(ListLoggingConfigurationsRequest request)
Retrieves an array of your LoggingConfiguration objects.
listLoggingConfigurations
in interface AWSWAFV2
listLoggingConfigurationsRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidOperationException
- The operation isn't valid.public ListManagedRuleSetsResult listManagedRuleSets(ListManagedRuleSetsRequest request)
Retrieves the managed rule sets that you own.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group
offerings for your customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
,
PutManagedRuleSetVersions
, and UpdateManagedRuleSetVersionExpiryDate
.
listManagedRuleSets
in interface AWSWAFV2
listManagedRuleSetsRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidOperationException
- The operation isn't valid.public ListRegexPatternSetsResult listRegexPatternSets(ListRegexPatternSetsRequest request)
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 WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidOperationException
- The operation isn't valid.public ListResourcesForWebACLResult listResourcesForWebACL(ListResourcesForWebACLRequest request)
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 Amazon CloudFront resources, use the CloudFront call
ListDistributionsByWebACLId
.
listResourcesForWebACL
in interface AWSWAFV2
listResourcesForWebACLRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidOperationException
- The operation isn't valid.public ListRuleGroupsResult listRuleGroups(ListRuleGroupsRequest request)
Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
listRuleGroups
in interface AWSWAFV2
listRuleGroupsRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidOperationException
- The operation isn't valid.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
listTagsForResource
in interface AWSWAFV2
listTagsForResourceRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- WAF couldn’t perform your tagging operation because of an internal error. Retry your request.WAFInvalidOperationException
- The operation isn't valid.public ListWebACLsResult listWebACLs(ListWebACLsRequest request)
Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
listWebACLs
in interface AWSWAFV2
listWebACLsRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidOperationException
- The operation isn't valid.public PutLoggingConfigurationResult putLoggingConfiguration(PutLoggingConfigurationRequest request)
Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
You can access information about all traffic that 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).
Give the data firehose a name that starts with the prefix aws-waf-logs-
. For example,
aws-waf-logs-us-east-2-analytics
.
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, 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 WAF Developer Guide.
This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.
putLoggingConfiguration
in interface AWSWAFV2
putLoggingConfigurationRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFServiceLinkedRoleErrorException
- WAF is not able to access the service linked role. This can be caused by a previous
PutLoggingConfiguration
request, which can lock the service linked role for about 20
seconds. Please try your request again. The service linked role can also be locked by a previous
DeleteServiceLinkedRole
request, which can lock the role for 15 minutes or more. If you
recently made a call to DeleteServiceLinkedRole
, wait at least 15 minutes and try the
request again. If you receive this same exception again, you will have to wait additional time until the
role is unlocked.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidOperationException
- The operation isn't valid.WAFLimitsExceededException
- WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an Amazon Web Services account. For more
information, see WAF
quotas in the WAF Developer Guide.public PutManagedRuleSetVersionsResult putManagedRuleSetVersions(PutManagedRuleSetVersionsRequest request)
Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group
offerings for your customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
,
PutManagedRuleSetVersions
, and UpdateManagedRuleSetVersionExpiryDate
.
Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.
To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.
putManagedRuleSetVersions
in interface AWSWAFV2
putManagedRuleSetVersionsRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFInvalidOperationException
- The operation isn't valid.public PutPermissionPolicyResult putPermissionPolicy(PutPermissionPolicyRequest request)
Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.
You must be the owner of the rule group to perform this operation.
This action is subject to the following restrictions:
You can attach only one policy with each PutPermissionPolicy
request.
The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same Region.
The user making the request must be the owner of the rule group.
putPermissionPolicy
in interface AWSWAFV2
putPermissionPolicyRequest
- WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFInvalidPermissionPolicyException
- The operation failed because the specified policy isn't in the proper format.
The policy specifications must conform to the following:
The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
The policy must include specifications for Effect
, Action
, and
Principal
.
Effect
must specify Allow
.
Action
must specify wafv2:CreateWebACL
, wafv2:UpdateWebACL
, and
wafv2:PutFirewallManagerRuleGroups
. WAF rejects any extra actions or wildcard actions in the
policy.
The policy must not include a Resource
parameter.
For more information, see IAM Policies.
public TagResourceResult tagResource(TagResourceRequest request)
Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
tagResource
in interface AWSWAFV2
tagResourceRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFLimitsExceededException
- WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an Amazon Web Services account. For more
information, see WAF
quotas in the WAF Developer Guide.WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- WAF couldn’t perform your tagging operation because of an internal error. Retry your request.WAFInvalidOperationException
- The operation isn't valid.public UntagResourceResult untagResource(UntagResourceRequest request)
Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.
untagResource
in interface AWSWAFV2
untagResourceRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFTagOperationException
- An error occurred during the tagging operation. Retry your request.WAFTagOperationInternalErrorException
- WAF couldn’t perform your tagging operation because of an internal error. Retry your request.WAFInvalidOperationException
- The operation isn't valid.public UpdateIPSetResult updateIPSet(UpdateIPSetRequest request)
Updates the specified IPSet.
This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call.
updateIPSet
in interface AWSWAFV2
updateIPSetRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFDuplicateItemException
- WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFLimitsExceededException
- WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an Amazon Web Services account. For more
information, see WAF
quotas in the WAF Developer Guide.WAFInvalidOperationException
- The operation isn't valid.public UpdateManagedRuleSetVersionExpiryDateResult updateManagedRuleSetVersionExpiryDate(UpdateManagedRuleSetVersionExpiryDateRequest request)
Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the reponse to ListAvailableManagedRuleGroupVersions for the managed rule group.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group
offerings for your customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
,
PutManagedRuleSetVersions
, and UpdateManagedRuleSetVersionExpiryDate
.
updateManagedRuleSetVersionExpiryDate
in interface AWSWAFV2
updateManagedRuleSetVersionExpiryDateRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFInvalidOperationException
- The operation isn't valid.public UpdateRegexPatternSetResult updateRegexPatternSet(UpdateRegexPatternSetRequest request)
Updates the specified RegexPatternSet.
This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call.
updateRegexPatternSet
in interface AWSWAFV2
updateRegexPatternSetRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFDuplicateItemException
- WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFLimitsExceededException
- WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an Amazon Web Services account. For more
information, see WAF
quotas in the WAF Developer Guide.WAFInvalidOperationException
- The operation isn't valid.public UpdateRuleGroupResult updateRuleGroup(UpdateRuleGroupRequest request)
Updates the specified RuleGroup.
This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
updateRuleGroup
in interface AWSWAFV2
updateRuleGroupRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFDuplicateItemException
- WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFLimitsExceededException
- WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an Amazon Web Services account. For more
information, see WAF
quotas in the WAF Developer Guide.WAFUnavailableEntityException
- WAF couldn’t retrieve the resource that you requested. Retry your request.WAFSubscriptionNotFoundException
- You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it
yet.WAFInvalidOperationException
- The operation isn't valid.public UpdateWebACLResult updateWebACL(UpdateWebACLRequest request)
Updates the specified WebACL.
This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call.
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has 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 Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.
updateWebACL
in interface AWSWAFV2
updateWebACLRequest
- WAFInternalErrorException
- Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your
request.WAFInvalidParameterException
- The operation failed because WAF didn't recognize a parameter in the request. For example:
You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL
with a DefaultAction
that isn't among the types
available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException
- WAF couldn’t perform the operation because your resource doesn’t exist.WAFDuplicateItemException
- WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an
existing one.WAFOptimisticLockException
- WAF couldn’t save your changes because you tried to update or delete a resource that has changed since
you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and
retry your operation.WAFLimitsExceededException
- WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum
number of WebACL
objects that you can create for an Amazon Web Services account. For more
information, see WAF
quotas in the WAF Developer Guide.WAFInvalidResourceException
- WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the
resource, and try again.WAFUnavailableEntityException
- WAF couldn’t retrieve the resource that you requested. Retry your request.WAFSubscriptionNotFoundException
- You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it
yet.WAFInvalidOperationException
- The operation isn't valid.WAFExpiredManagedRuleGroupVersionException
- The operation failed because the specified version for the managed rule group has expired. You can
retrieve the available versions for the managed rule group by calling
ListAvailableManagedRuleGroupVersions.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 requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSWAFV2
shutdown
in class AmazonWebServiceClient