@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSWAFClient extends AmazonWebServiceClient implements AWSWAF
This is the AWS WAF API Reference for using AWS WAF with Amazon CloudFront. The AWS WAF actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSWAFClient()
Deprecated.
|
AWSWAFClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSWAFClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSWAFClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSWAFClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSWAFClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSWAFClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSWAFClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@Deprecated public AWSWAFClient()
AWSWAFClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSWAFClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to WAF (ex: proxy settings, retry
counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSWAFClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSWAFClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSWAFClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to WAF (ex: proxy settings, retry
counts, etc.).@Deprecated public AWSWAFClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSWAFClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to WAF (ex: proxy settings, retry
counts, etc.).@Deprecated public AWSWAFClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to WAF (ex: proxy settings, retry
counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSWAFClientBuilder builder()
public CreateByteMatchSetResult createByteMatchSet(CreateByteMatchSetRequest request)
Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request
that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string.
For example, you can create a ByteMatchSet that matches any requests with User-Agent
headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.
To create and configure a ByteMatchSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateByteMatchSet request.
Submit a CreateByteMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateByteMatchSet request.
Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createByteMatchSet in interface AWSWAFcreateByteMatchSetRequest - WAFDisallowedNameException - The name specified is invalid.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public CreateGeoMatchSetResult createGeoMatchSet(CreateGeoMatchSetRequest request)
Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on
the country that the requests originate from. For example, if you're receiving a lot of requests from one or more
countries and you want to block the requests, you can create an GeoMatchSet that contains those
countries and then configure AWS WAF to block the requests.
To create and configure a GeoMatchSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateGeoMatchSet request.
Submit a CreateGeoMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateGeoMatchSet request.
Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createGeoMatchSet in interface AWSWAFcreateGeoMatchSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFDisallowedNameException - The name specified is invalid.WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public CreateIPSetResult createIPSet(CreateIPSetRequest request)
Creates an IPSet, which you use to specify which web requests you want to allow or block based on the IP
addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more
individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create
an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.
To create and configure an IPSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateIPSet request.
Submit a CreateIPSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateIPSet request.
Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createIPSet in interface AWSWAFcreateIPSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFDisallowedNameException - The name specified is invalid.WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public CreateRateBasedRuleResult createRateBasedRule(CreateRateBasedRuleRequest request)
Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies
the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The
RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and
other predicates that identify the requests that you want to count or block if these requests exceed the
RateLimit.
If you add more than one predicate to a RateBasedRule, a request not only must exceed the
RateLimit, but it also must match all the specifications to be counted or blocked. For example,
suppose you add the following to a RateBasedRule:
An IPSet that matches the IP address 192.0.2.44/32
A ByteMatchSet that matches BadBot in the User-Agent header
Further, you specify a RateLimit of 15,000.
You then add the RateBasedRule to a WebACL and specify that you want to block requests
that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44
and the User-Agent header in the request must contain the value BadBot. Further,
requests that match these two conditions must be received at a rate of more than 15,000 requests every five
minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops
below 15,000 for a five-minute period, AWS WAF no longer blocks the requests.
As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could
add the following to a RateBasedRule:
A ByteMatchSet with FieldToMatch of URI
A PositionalConstraint of STARTS_WITH
A TargetString of login
Further, you specify a RateLimit of 15,000.
By adding this RateBasedRule to a WebACL, you could limit requests to your login page
without affecting the rest of your site.
To create and configure a RateBasedRule, perform the following steps:
Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateRule request.
Submit a CreateRateBasedRule request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the
rule.
Create and update a WebACL that contains the RateBasedRule. For more information, see
CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createRateBasedRule in interface AWSWAFcreateRateBasedRuleRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFDisallowedNameException - The name specified is invalid.WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public CreateRegexMatchSetResult createRegexMatchSet(CreateRegexMatchSetRequest request)
Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request
that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string.
For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks
for any requests with User-Agent headers that match a RegexPatternSet with pattern
B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.
To create and configure a RegexMatchSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateRegexMatchSet request.
Submit a CreateRegexMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexMatchSet request.
Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect
(for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF
to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createRegexMatchSet in interface AWSWAFcreateRegexMatchSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFDisallowedNameException - The name specified is invalid.WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public CreateRegexPatternSetResult createRegexPatternSet(CreateRegexPatternSetRequest request)
Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular
expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then
configure AWS WAF to reject those requests.
To create and configure a RegexPatternSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateRegexPatternSet request.
Submit a CreateRegexPatternSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexPatternSet request.
Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createRegexPatternSet in interface AWSWAFcreateRegexPatternSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFDisallowedNameException - The name specified is invalid.WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public CreateRuleResult createRule(CreateRuleRequest request)
Creates a Rule, which contains the IPSet objects, ByteMatchSet objects,
and other predicates that identify the requests that you want to block. If you add more than one predicate to a
Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose
you add the following to a Rule:
An IPSet that matches the IP address 192.0.2.44/32
A ByteMatchSet that matches BadBot in the User-Agent header
You then add the Rule to a WebACL and specify that you want to blocks requests that
satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44
and the User-Agent header in the request must contain the value BadBot.
To create and configure a Rule, perform the following steps:
Create and update the predicates that you want to include in the Rule. For more information, see
CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateRule request.
Submit a CreateRule request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRule request to specify the predicates that you want to include in the
Rule.
Create and update a WebACL that contains the Rule. For more information, see
CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createRule in interface AWSWAFcreateRuleRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFDisallowedNameException - The name specified is invalid.WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public CreateSizeConstraintSetResult createSizeConstraintSet(CreateSizeConstraintSetRequest request)
Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a
web request that you want AWS WAF to check for length, such as the length of the User-Agent header
or the length of the query string. For example, you can create a SizeConstraintSet that matches any
requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those
requests.
To create and configure a SizeConstraintSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateSizeConstraintSet request.
Submit a CreateSizeConstraintSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateSizeConstraintSet request.
Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createSizeConstraintSet in interface AWSWAFcreateSizeConstraintSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFDisallowedNameException - The name specified is invalid.WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public CreateSqlInjectionMatchSetResult createSqlInjectionMatchSet(CreateSqlInjectionMatchSetRequest request)
Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure a SqlInjectionMatchSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateSqlInjectionMatchSet request.
Submit a CreateSqlInjectionMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateSqlInjectionMatchSet request.
Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createSqlInjectionMatchSet in interface AWSWAFcreateSqlInjectionMatchSetRequest - A request to create a SqlInjectionMatchSet.WAFDisallowedNameException - The name specified is invalid.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public CreateWebACLResult createWebACL(CreateWebACLRequest request)
Creates a WebACL, which contains the Rules that identify the CloudFront web requests
that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of
Priority for each Rule.
You also specify a default action, either ALLOW or BLOCK. If a web request doesn't
match any of the Rules in a WebACL, AWS WAF responds to the request with the default
action.
To create and configure a WebACL, perform the following steps:
Create and update the ByteMatchSet objects and other predicates that you want to include in
Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet,
CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules that you want to include in the WebACL. For more
information, see CreateRule and UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateWebACL request.
Submit a CreateWebACL request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateWebACL request.
Submit an UpdateWebACL request to specify the Rules that you want to include in the
WebACL, to specify the default action, and to associate the WebACL with a CloudFront
distribution.
For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
createWebACL in interface AWSWAFcreateWebACLRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFDisallowedNameException - The name specified is invalid.WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public CreateXssMatchSetResult createXssMatchSet(CreateXssMatchSetRequest request)
Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure an XssMatchSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateXssMatchSet request.
Submit a CreateXssMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateXssMatchSet request.
Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
createXssMatchSet in interface AWSWAFcreateXssMatchSetRequest - A request to create an XssMatchSet.WAFDisallowedNameException - The name specified is invalid.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public DeleteByteMatchSetResult deleteByteMatchSet(DeleteByteMatchSetRequest request)
Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any
Rules or if it still includes any ByteMatchTuple objects (any filters).
If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.
To permanently delete a ByteMatchSet, perform the following steps:
Update the ByteMatchSet to remove filters, if any. For more information, see
UpdateByteMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteByteMatchSet request.
Submit a DeleteByteMatchSet request.
deleteByteMatchSet in interface AWSWAFdeleteByteMatchSetRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL that still contains one or more Rule objects.
You tried to delete a Rule that still contains one or more ByteMatchSet objects
or other predicates.
You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet that references one or more IP addresses.
public DeleteGeoMatchSetResult deleteGeoMatchSet(DeleteGeoMatchSetRequest request)
Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any
Rules or if it still includes any countries.
If you just want to remove a GeoMatchSet from a Rule, use UpdateRule.
To permanently delete a GeoMatchSet from AWS WAF, perform the following steps:
Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteGeoMatchSet request.
Submit a DeleteGeoMatchSet request.
deleteGeoMatchSet in interface AWSWAFdeleteGeoMatchSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL that still contains one or more Rule objects.
You tried to delete a Rule that still contains one or more ByteMatchSet objects
or other predicates.
You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet that references one or more IP addresses.
public DeleteIPSetResult deleteIPSet(DeleteIPSetRequest request)
Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any
Rules or if it still includes any IP addresses.
If you just want to remove an IPSet from a Rule, use UpdateRule.
To permanently delete an IPSet from AWS WAF, perform the following steps:
Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteIPSet request.
Submit a DeleteIPSet request.
deleteIPSet in interface AWSWAFdeleteIPSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL that still contains one or more Rule objects.
You tried to delete a Rule that still contains one or more ByteMatchSet objects
or other predicates.
You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet that references one or more IP addresses.
public DeleteRateBasedRuleResult deleteRateBasedRule(DeleteRateBasedRuleRequest request)
Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL
objects or if it still includes any predicates, such as ByteMatchSet objects.
If you just want to remove a rule from a WebACL, use UpdateWebACL.
To permanently delete a RateBasedRule from AWS WAF, perform the following steps:
Update the RateBasedRule to remove predicates, if any. For more information, see
UpdateRateBasedRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteRateBasedRule request.
Submit a DeleteRateBasedRule request.
deleteRateBasedRule in interface AWSWAFdeleteRateBasedRuleRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL that still contains one or more Rule objects.
You tried to delete a Rule that still contains one or more ByteMatchSet objects
or other predicates.
You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet that references one or more IP addresses.
public DeleteRegexMatchSetResult deleteRegexMatchSet(DeleteRegexMatchSetRequest request)
Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in
any Rules or if it still includes any RegexMatchTuples objects (any filters).
If you just want to remove a RegexMatchSet from a Rule, use UpdateRule.
To permanently delete a RegexMatchSet, perform the following steps:
Update the RegexMatchSet to remove filters, if any. For more information, see
UpdateRegexMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteRegexMatchSet request.
Submit a DeleteRegexMatchSet request.
deleteRegexMatchSet in interface AWSWAFdeleteRegexMatchSetRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL that still contains one or more Rule objects.
You tried to delete a Rule that still contains one or more ByteMatchSet objects
or other predicates.
You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet that references one or more IP addresses.
public DeleteRegexPatternSetResult deleteRegexPatternSet(DeleteRegexPatternSetRequest request)
Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used
in any RegexMatchSet or if the RegexPatternSet is not empty.
deleteRegexPatternSet in interface AWSWAFdeleteRegexPatternSetRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL that still contains one or more Rule objects.
You tried to delete a Rule that still contains one or more ByteMatchSet objects
or other predicates.
You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet that references one or more IP addresses.
public DeleteRuleResult deleteRule(DeleteRuleRequest request)
Permanently deletes a Rule. You can't delete a Rule if it's still used in any
WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.
If you just want to remove a Rule from a WebACL, use UpdateWebACL.
To permanently delete a Rule from AWS WAF, perform the following steps:
Update the Rule to remove predicates, if any. For more information, see UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteRule request.
Submit a DeleteRule request.
deleteRule in interface AWSWAFdeleteRuleRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL that still contains one or more Rule objects.
You tried to delete a Rule that still contains one or more ByteMatchSet objects
or other predicates.
You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet that references one or more IP addresses.
public DeleteSizeConstraintSetResult deleteSizeConstraintSet(DeleteSizeConstraintSetRequest request)
Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still
used in any Rules or if it still includes any SizeConstraint objects (any filters).
If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.
To permanently delete a SizeConstraintSet, perform the following steps:
Update the SizeConstraintSet to remove filters, if any. For more information, see
UpdateSizeConstraintSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteSizeConstraintSet request.
Submit a DeleteSizeConstraintSet request.
deleteSizeConstraintSet in interface AWSWAFdeleteSizeConstraintSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL that still contains one or more Rule objects.
You tried to delete a Rule that still contains one or more ByteMatchSet objects
or other predicates.
You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet that references one or more IP addresses.
public DeleteSqlInjectionMatchSetResult deleteSqlInjectionMatchSet(DeleteSqlInjectionMatchSetRequest request)
Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's
still used in any Rules or if it still contains any SqlInjectionMatchTuple objects.
If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule.
To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps:
Update the SqlInjectionMatchSet to remove filters, if any. For more information, see
UpdateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteSqlInjectionMatchSet request.
Submit a DeleteSqlInjectionMatchSet request.
deleteSqlInjectionMatchSet in interface AWSWAFdeleteSqlInjectionMatchSetRequest - A request to delete a SqlInjectionMatchSet from AWS WAF.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL that still contains one or more Rule objects.
You tried to delete a Rule that still contains one or more ByteMatchSet objects
or other predicates.
You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet that references one or more IP addresses.
public DeleteWebACLResult deleteWebACL(DeleteWebACLRequest request)
Permanently deletes a WebACL. You can't delete a WebACL if it still contains any
Rules.
To delete a WebACL, perform the following steps:
Update the WebACL to remove Rules, if any. For more information, see
UpdateWebACL.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteWebACL request.
Submit a DeleteWebACL request.
deleteWebACL in interface AWSWAFdeleteWebACLRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL that still contains one or more Rule objects.
You tried to delete a Rule that still contains one or more ByteMatchSet objects
or other predicates.
You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet that references one or more IP addresses.
public DeleteXssMatchSetResult deleteXssMatchSet(DeleteXssMatchSetRequest request)
Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any
Rules or if it still contains any XssMatchTuple objects.
If you just want to remove an XssMatchSet from a Rule, use UpdateRule.
To permanently delete an XssMatchSet from AWS WAF, perform the following steps:
Update the XssMatchSet to remove filters, if any. For more information, see
UpdateXssMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteXssMatchSet request.
Submit a DeleteXssMatchSet request.
deleteXssMatchSet in interface AWSWAFdeleteXssMatchSetRequest - A request to delete an XssMatchSet from AWS WAF.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFNonEmptyEntityException - The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL that still contains one or more Rule objects.
You tried to delete a Rule that still contains one or more ByteMatchSet objects
or other predicates.
You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet that references one or more IP addresses.
public GetByteMatchSetResult getByteMatchSet(GetByteMatchSetRequest request)
Returns the ByteMatchSet specified by ByteMatchSetId.
getByteMatchSet in interface AWSWAFgetByteMatchSetRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.public GetChangeTokenResult getChangeToken(GetChangeTokenRequest request)
When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If your application submits a
GetChangeToken request and then submits a second GetChangeToken request before
submitting a create, update, or delete request, the second GetChangeToken request returns the same
value as the first GetChangeToken request.
When you use a change token in a create, update, or delete request, the status of the change token changes to
PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use
GetChangeTokenStatus to determine the status of your change token.
getChangeToken in interface AWSWAFgetChangeTokenRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.public GetChangeTokenStatusResult getChangeTokenStatus(GetChangeTokenStatusRequest request)
Returns the status of a ChangeToken that you got by calling GetChangeToken.
ChangeTokenStatus is one of the following values:
PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't
used it yet in a call to create, update, or delete an AWS WAF object.
PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.
IN_SYNC: Propagation is complete.
getChangeTokenStatus in interface AWSWAFgetChangeTokenStatusRequest - WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.public GetGeoMatchSetResult getGeoMatchSet(GetGeoMatchSetRequest request)
Returns the GeoMatchSet that is specified by GeoMatchSetId.
getGeoMatchSet in interface AWSWAFgetGeoMatchSetRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.public GetIPSetResult getIPSet(GetIPSetRequest request)
Returns the IPSet that is specified by IPSetId.
getIPSet in interface AWSWAFgetIPSetRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.public GetRateBasedRuleResult getRateBasedRule(GetRateBasedRuleRequest request)
Returns the RateBasedRule that is specified by the RuleId that you included in the
GetRateBasedRule request.
getRateBasedRule in interface AWSWAFgetRateBasedRuleRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.public GetRateBasedRuleManagedKeysResult getRateBasedRuleManagedKeys(GetRateBasedRuleManagedKeysRequest request)
Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the
RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000
addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.
getRateBasedRuleManagedKeys in interface AWSWAFgetRateBasedRuleManagedKeysRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
public GetRegexMatchSetResult getRegexMatchSet(GetRegexMatchSetRequest request)
Returns the RegexMatchSet specified by RegexMatchSetId.
getRegexMatchSet in interface AWSWAFgetRegexMatchSetRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.public GetRegexPatternSetResult getRegexPatternSet(GetRegexPatternSetRequest request)
Returns the RegexPatternSet specified by RegexPatternSetId.
getRegexPatternSet in interface AWSWAFgetRegexPatternSetRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.public GetRuleResult getRule(GetRuleRequest request)
Returns the Rule that is specified by the RuleId that you included in the
GetRule request.
getRule in interface AWSWAFgetRuleRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.public GetSampledRequestsResult getSampledRequests(GetSampledRequestsRequest request)
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 AWSWAFgetSampledRequestsRequest - WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.public GetSizeConstraintSetResult getSizeConstraintSet(GetSizeConstraintSetRequest request)
Returns the SizeConstraintSet specified by SizeConstraintSetId.
getSizeConstraintSet in interface AWSWAFgetSizeConstraintSetRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.public GetSqlInjectionMatchSetResult getSqlInjectionMatchSet(GetSqlInjectionMatchSetRequest request)
Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.
getSqlInjectionMatchSet in interface AWSWAFgetSqlInjectionMatchSetRequest - A request to get a SqlInjectionMatchSet.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.public GetWebACLResult getWebACL(GetWebACLRequest request)
Returns the WebACL that is specified by WebACLId.
getWebACL in interface AWSWAFgetWebACLRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.public GetXssMatchSetResult getXssMatchSet(GetXssMatchSetRequest request)
Returns the XssMatchSet that is specified by XssMatchSetId.
getXssMatchSet in interface AWSWAFgetXssMatchSetRequest - A request to get an XssMatchSet.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.public ListByteMatchSetsResult listByteMatchSets(ListByteMatchSetsRequest request)
Returns an array of ByteMatchSetSummary objects.
listByteMatchSets in interface AWSWAFlistByteMatchSetsRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.public ListGeoMatchSetsResult listGeoMatchSets(ListGeoMatchSetsRequest request)
Returns an array of GeoMatchSetSummary objects in the response.
listGeoMatchSets in interface AWSWAFlistGeoMatchSetsRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.public ListIPSetsResult listIPSets(ListIPSetsRequest request)
Returns an array of IPSetSummary objects in the response.
listIPSets in interface AWSWAFlistIPSetsRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.public ListRateBasedRulesResult listRateBasedRules(ListRateBasedRulesRequest request)
Returns an array of RuleSummary objects.
listRateBasedRules in interface AWSWAFlistRateBasedRulesRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.public ListRegexMatchSetsResult listRegexMatchSets(ListRegexMatchSetsRequest request)
Returns an array of RegexMatchSetSummary objects.
listRegexMatchSets in interface AWSWAFlistRegexMatchSetsRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.public ListRegexPatternSetsResult listRegexPatternSets(ListRegexPatternSetsRequest request)
Returns an array of RegexPatternSetSummary objects.
listRegexPatternSets in interface AWSWAFlistRegexPatternSetsRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.public ListRulesResult listRules(ListRulesRequest request)
Returns an array of RuleSummary objects.
listRules in interface AWSWAFlistRulesRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.public ListSizeConstraintSetsResult listSizeConstraintSets(ListSizeConstraintSetsRequest request)
Returns an array of SizeConstraintSetSummary objects.
listSizeConstraintSets in interface AWSWAFlistSizeConstraintSetsRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.public ListSqlInjectionMatchSetsResult listSqlInjectionMatchSets(ListSqlInjectionMatchSetsRequest request)
Returns an array of SqlInjectionMatchSet objects.
listSqlInjectionMatchSets in interface AWSWAFlistSqlInjectionMatchSetsRequest - A request to list the SqlInjectionMatchSet objects created by the current AWS account.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.public ListWebACLsResult listWebACLs(ListWebACLsRequest request)
Returns an array of WebACLSummary objects in the response.
listWebACLs in interface AWSWAFlistWebACLsRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.public ListXssMatchSetsResult listXssMatchSets(ListXssMatchSetsRequest request)
Returns an array of XssMatchSet objects.
listXssMatchSets in interface AWSWAFlistXssMatchSetsRequest - A request to list the XssMatchSet objects created by the current AWS account.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.public UpdateByteMatchSetResult updateByteMatchSet(UpdateByteMatchSetRequest request)
Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each
ByteMatchTuple object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate
object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
User-Agent header.
The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more
information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see
TargetString in the ByteMatchTuple data type.
Where to look, such as at the beginning or the end of a query string.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can add a ByteMatchSetUpdate object that matches web requests in which
User-Agent headers contain the string BadBot. You can then configure AWS WAF to block
those requests.
To create and configure a ByteMatchSet, perform the following steps:
Create a ByteMatchSet. For more information, see CreateByteMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of
an UpdateByteMatchSet request.
Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to
inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateByteMatchSet in interface AWSWAFupdateByteMatchSetRequest - WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidOperationException - The operation failed because there was nothing to do. For example:
You tried to remove a Rule from a WebACL, but the Rule isn't in
the specified WebACL.
You tried to remove an IP address from an IPSet, but the IP address isn't in the specified
IPSet.
You tried to remove a ByteMatchTuple from a ByteMatchSet, but the
ByteMatchTuple isn't in the specified WebACL.
You tried to add a Rule to a WebACL, but the Rule already exists
in the specified WebACL.
You tried to add an IP address to an IPSet, but the IP address already exists in the
specified IPSet.
You tried to add a ByteMatchTuple to a ByteMatchSet, but the
ByteMatchTuple already exists in the specified WebACL.
WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule to or delete a Rule from a WebACL that
doesn't exist.
You tried to add a ByteMatchSet to or delete a ByteMatchSet from a
Rule that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a
ByteMatchSet that doesn't exist.
WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public UpdateGeoMatchSetResult updateGeoMatchSet(UpdateGeoMatchSetRequest request)
Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each
GeoMatchConstraint object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint
object, you delete the existing object and add a new one.
The Type. The only valid value for Type is Country.
The Value, which is a two character code for the country to add to the
GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value.
To create and configure an GeoMatchSet, perform the following steps:
Submit a CreateGeoMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of
an UpdateGeoMatchSet request.
Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for.
When you update an GeoMatchSet, you specify the country that you want to add and/or the country that
you want to delete. If you want to change a country, you delete the existing country and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateGeoMatchSet in interface AWSWAFupdateGeoMatchSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidOperationException - The operation failed because there was nothing to do. For example:
You tried to remove a Rule from a WebACL, but the Rule isn't in
the specified WebACL.
You tried to remove an IP address from an IPSet, but the IP address isn't in the specified
IPSet.
You tried to remove a ByteMatchTuple from a ByteMatchSet, but the
ByteMatchTuple isn't in the specified WebACL.
You tried to add a Rule to a WebACL, but the Rule already exists
in the specified WebACL.
You tried to add an IP address to an IPSet, but the IP address already exists in the
specified IPSet.
You tried to add a ByteMatchTuple to a ByteMatchSet, but the
ByteMatchTuple already exists in the specified WebACL.
WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule to or delete a Rule from a WebACL that
doesn't exist.
You tried to add a ByteMatchSet to or delete a ByteMatchSet from a
Rule that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a
ByteMatchSet that doesn't exist.
WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public UpdateIPSetResult updateIPSet(UpdateIPSetRequest request)
Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor
object, you delete the existing object and add a new one.
The IP address version, IPv4 or IPv6.
The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from
192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address
192.0.2.44).
AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
IPv6 addresses can be represented using any of the following formats:
1111:0000:0000:0000:0000:0000:0000:0111/128
1111:0:0:0:0:0:0:0111/128
1111::0111/128
1111::111/128
You use an IPSet to specify which web requests you want to allow or block based on the IP addresses
that the requests originated from. For example, if you're receiving a lot of requests from one or a small number
of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP
addresses, and then configure AWS WAF to block the requests.
To create and configure an IPSet, perform the following steps:
Submit a CreateIPSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of
an UpdateIPSet request.
Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.
When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses
that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new
one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateIPSet in interface AWSWAFupdateIPSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidOperationException - The operation failed because there was nothing to do. For example:
You tried to remove a Rule from a WebACL, but the Rule isn't in
the specified WebACL.
You tried to remove an IP address from an IPSet, but the IP address isn't in the specified
IPSet.
You tried to remove a ByteMatchTuple from a ByteMatchSet, but the
ByteMatchTuple isn't in the specified WebACL.
You tried to add a Rule to a WebACL, but the Rule already exists
in the specified WebACL.
You tried to add an IP address to an IPSet, but the IP address already exists in the
specified IPSet.
You tried to add a ByteMatchTuple to a ByteMatchSet, but the
ByteMatchTuple already exists in the specified WebACL.
WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule to or delete a Rule from a WebACL that
doesn't exist.
You tried to add a ByteMatchSet to or delete a ByteMatchSet from a
Rule that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a
ByteMatchSet that doesn't exist.
WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public UpdateRateBasedRuleResult updateRateBasedRule(UpdateRateBasedRuleRequest request)
Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule.
Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that
specifies the web requests that you want to block or count. The RateLimit specifies the number of
requests every five minutes that triggers the rule.
If you add more than one predicate to a RateBasedRule, a request must match all the predicates and
exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a
RateBasedRule:
An IPSet that matches the IP address 192.0.2.44/32
A ByteMatchSet that matches BadBot in the User-Agent header
Further, you specify a RateLimit of 15,000.
You then add the RateBasedRule to a WebACL and specify that you want to block requests
that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the
User-Agent header in the request must contain the value BadBot. Further, requests that
match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops
below this limit, AWS WAF no longer blocks the requests.
As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could
add the following to a RateBasedRule:
A ByteMatchSet with FieldToMatch of URI
A PositionalConstraint of STARTS_WITH
A TargetString of login
Further, you specify a RateLimit of 15,000.
By adding this RateBasedRule to a WebACL, you could limit requests to your login page
without affecting the rest of your site.
updateRateBasedRule in interface AWSWAFupdateRateBasedRuleRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidOperationException - The operation failed because there was nothing to do. For example:
You tried to remove a Rule from a WebACL, but the Rule isn't in
the specified WebACL.
You tried to remove an IP address from an IPSet, but the IP address isn't in the specified
IPSet.
You tried to remove a ByteMatchTuple from a ByteMatchSet, but the
ByteMatchTuple isn't in the specified WebACL.
You tried to add a Rule to a WebACL, but the Rule already exists
in the specified WebACL.
You tried to add an IP address to an IPSet, but the IP address already exists in the
specified IPSet.
You tried to add a ByteMatchTuple to a ByteMatchSet, but the
ByteMatchTuple already exists in the specified WebACL.
WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule to or delete a Rule from a WebACL that
doesn't exist.
You tried to add a ByteMatchSet to or delete a ByteMatchSet from a
Rule that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a
ByteMatchSet that doesn't exist.
WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public UpdateRegexMatchSetResult updateRegexMatchSet(UpdateRegexMatchSetRequest request)
Inserts or deletes RegexMatchSetUpdate objects (filters) in a RegexMatchSet. For each
RegexMatchSetUpdate object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate
object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
User-Agent header.
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can create a RegexPatternSet that matches any requests with User-Agent
headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those
requests.
To create and configure a RegexMatchSet, perform the following steps:
Create a RegexMatchSet. For more information, see CreateRegexMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of
an UpdateRegexMatchSet request.
Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to
inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain
the regular expression patters you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateRegexMatchSet in interface AWSWAFupdateRegexMatchSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFDisallowedNameException - The name specified is invalid.WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule to or delete a Rule from a WebACL that
doesn't exist.
You tried to add a ByteMatchSet to or delete a ByteMatchSet from a
Rule that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a
ByteMatchSet that doesn't exist.
WAFInvalidOperationException - The operation failed because there was nothing to do. For example:
You tried to remove a Rule from a WebACL, but the Rule isn't in
the specified WebACL.
You tried to remove an IP address from an IPSet, but the IP address isn't in the specified
IPSet.
You tried to remove a ByteMatchTuple from a ByteMatchSet, but the
ByteMatchTuple isn't in the specified WebACL.
You tried to add a Rule to a WebACL, but the Rule already exists
in the specified WebACL.
You tried to add an IP address to an IPSet, but the IP address already exists in the
specified IPSet.
You tried to add a ByteMatchTuple to a ByteMatchSet, but the
ByteMatchTuple already exists in the specified WebACL.
WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.public UpdateRegexPatternSetResult updateRegexPatternSet(UpdateRegexPatternSetRequest request)
Inserts or deletes RegexMatchSetUpdate objects (filters) in a RegexPatternSet. For each
RegexPatternSet object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a RegexPatternSet
object, you delete the existing object and add a new one.
The regular expression pattern that you want AWS WAF to look for. For more information, see RegexPatternSet.
For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will
match this RegexPatternString to:
BadBot
BadB0t
B@dBot
B@dB0t
To create and configure a RegexPatternSet, perform the following steps:
Create a RegexPatternSet. For more information, see CreateRegexPatternSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of
an UpdateRegexPatternSet request.
Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS
WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateRegexPatternSet in interface AWSWAFupdateRegexPatternSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.WAFNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule to or delete a Rule from a WebACL that
doesn't exist.
You tried to add a ByteMatchSet to or delete a ByteMatchSet from a
Rule that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a
ByteMatchSet that doesn't exist.
WAFInvalidOperationException - The operation failed because there was nothing to do. For example:
You tried to remove a Rule from a WebACL, but the Rule isn't in
the specified WebACL.
You tried to remove an IP address from an IPSet, but the IP address isn't in the specified
IPSet.
You tried to remove a ByteMatchTuple from a ByteMatchSet, but the
ByteMatchTuple isn't in the specified WebACL.
You tried to add a Rule to a WebACL, but the Rule already exists
in the specified WebACL.
You tried to add an IP address to an IPSet, but the IP address already exists in the
specified IPSet.
You tried to add a ByteMatchTuple to a ByteMatchSet, but the
ByteMatchTuple already exists in the specified WebACL.
WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidRegexPatternException - The regular expression (regex) you specified in RegexPatternString is invalid.public UpdateRuleResult updateRule(UpdateRuleRequest request)
Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies
a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to
allow, block, or count. If you add more than one predicate to a Rule, a request must match all of
the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a
Rule:
A ByteMatchSet that matches the value BadBot in the User-Agent header
An IPSet that matches the IP address 192.0.2.44
You then add the Rule to a WebACL and specify that you want to block requests that
satisfy the Rule. For a request to be blocked, the User-Agent header in the request
must contain the value BadBot and the request must originate from the IP address 192.0.2.44.
To create and configure a Rule, perform the following steps:
Create and update the predicates that you want to include in the Rule.
Create the Rule. See CreateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRule request to add predicates to the Rule.
Create and update a WebACL that contains the Rule. See CreateWebACL.
If you want to replace one ByteMatchSet or IPSet with another, you delete the existing
one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateRule in interface AWSWAFupdateRuleRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidOperationException - The operation failed because there was nothing to do. For example:
You tried to remove a Rule from a WebACL, but the Rule isn't in
the specified WebACL.
You tried to remove an IP address from an IPSet, but the IP address isn't in the specified
IPSet.
You tried to remove a ByteMatchTuple from a ByteMatchSet, but the
ByteMatchTuple isn't in the specified WebACL.
You tried to add a Rule to a WebACL, but the Rule already exists
in the specified WebACL.
You tried to add an IP address to an IPSet, but the IP address already exists in the
specified IPSet.
You tried to add a ByteMatchTuple to a ByteMatchSet, but the
ByteMatchTuple already exists in the specified WebACL.
WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule to or delete a Rule from a WebACL that
doesn't exist.
You tried to add a ByteMatchSet to or delete a ByteMatchSet from a
Rule that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a
ByteMatchSet that doesn't exist.
WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public UpdateSizeConstraintSetResult updateSizeConstraintSet(UpdateSizeConstraintSetRequest request)
Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each
SizeConstraint object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a
SizeConstraintSetUpdate object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length
of the User-Agent header.
Whether to perform any transformations on the request, such as converting it to lowercase, before checking its
length. Note that transformations of the request body are not supported because the AWS resource forwards only
the first 8192 bytes of your request to AWS WAF.
A ComparisonOperator used for evaluating the selected part of the request against the specified
Size, such as equals, greater than, less than, and so on.
The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.
For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the
length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block
those requests.
To create and configure a SizeConstraintSet, perform the following steps:
Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of
an UpdateSizeConstraintSet request.
Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF
to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateSizeConstraintSet in interface AWSWAFupdateSizeConstraintSetRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidOperationException - The operation failed because there was nothing to do. For example:
You tried to remove a Rule from a WebACL, but the Rule isn't in
the specified WebACL.
You tried to remove an IP address from an IPSet, but the IP address isn't in the specified
IPSet.
You tried to remove a ByteMatchTuple from a ByteMatchSet, but the
ByteMatchTuple isn't in the specified WebACL.
You tried to add a Rule to a WebACL, but the Rule already exists
in the specified WebACL.
You tried to add an IP address to an IPSet, but the IP address already exists in the
specified IPSet.
You tried to add a ByteMatchTuple to a ByteMatchSet, but the
ByteMatchTuple already exists in the specified WebACL.
WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule to or delete a Rule from a WebACL that
doesn't exist.
You tried to add a ByteMatchSet to or delete a ByteMatchSet from a
Rule that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a
ByteMatchSet that doesn't exist.
WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public UpdateSqlInjectionMatchSetResult updateSqlInjectionMatchSet(UpdateSqlInjectionMatchSetRequest request)
Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each
SqlInjectionMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change a
SqlInjectionMatchTuple, you delete the existing object and add a new one.
FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to
inspect a header, the name of the header.
TextTransformation: Which text transformation, if any, to perform on the web request before
inspecting the request for snippets of malicious SQL code.
You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block,
or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you
want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and
then configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet, perform the following steps:
Submit a CreateSqlInjectionMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of
an UpdateIPSet request.
Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS
WAF to inspect for snippets of SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateSqlInjectionMatchSet in interface AWSWAFupdateSqlInjectionMatchSetRequest - A request to update a SqlInjectionMatchSet.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidOperationException - The operation failed because there was nothing to do. For example:
You tried to remove a Rule from a WebACL, but the Rule isn't in
the specified WebACL.
You tried to remove an IP address from an IPSet, but the IP address isn't in the specified
IPSet.
You tried to remove a ByteMatchTuple from a ByteMatchSet, but the
ByteMatchTuple isn't in the specified WebACL.
You tried to add a Rule to a WebACL, but the Rule already exists
in the specified WebACL.
You tried to add an IP address to an IPSet, but the IP address already exists in the
specified IPSet.
You tried to add a ByteMatchTuple to a ByteMatchSet, but the
ByteMatchTuple already exists in the specified WebACL.
WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule to or delete a Rule from a WebACL that
doesn't exist.
You tried to add a ByteMatchSet to or delete a ByteMatchSet from a
Rule that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a
ByteMatchSet that doesn't exist.
WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public UpdateWebACLResult updateWebACL(UpdateWebACLRequest request)
Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web
requests that you want to allow, block, or count. When you update a WebACL, you specify the
following values:
A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs
the default action if a request doesn't match the criteria in any of the Rules in a
WebACL.
The Rules that you want to add and/or delete. If you want to replace one Rule with
another, you delete the existing Rule and add the new one.
For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that
match the conditions in the Rule.
The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more
than one Rule to a WebACL, AWS WAF evaluates each request against the
Rules in order based on the value of Priority. (The Rule that has the
lowest value for Priority is evaluated first.) When a web request matches all of the predicates
(such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes
the corresponding action, allow or block, and doesn't evaluate the request against the remaining
Rules in the WebACL, if any.
To create and configure a WebACL, perform the following steps:
Create and update the predicates that you want to include in Rules. For more information, see
CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet,
CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules that you want to include in the WebACL. For more
information, see CreateRule and UpdateRule.
Create a WebACL. See CreateWebACL.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateWebACL request.
Submit an UpdateWebACL request to specify the Rules that you want to include in the
WebACL, to specify the default action, and to associate the WebACL with a CloudFront
distribution.
Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateWebACL in interface AWSWAFupdateWebACLRequest - WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidOperationException - The operation failed because there was nothing to do. For example:
You tried to remove a Rule from a WebACL, but the Rule isn't in
the specified WebACL.
You tried to remove an IP address from an IPSet, but the IP address isn't in the specified
IPSet.
You tried to remove a ByteMatchTuple from a ByteMatchSet, but the
ByteMatchTuple isn't in the specified WebACL.
You tried to add a Rule to a WebACL, but the Rule already exists
in the specified WebACL.
You tried to add an IP address to an IPSet, but the IP address already exists in the
specified IPSet.
You tried to add a ByteMatchTuple to a ByteMatchSet, but the
ByteMatchTuple already exists in the specified WebACL.
WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule to or delete a Rule from a WebACL that
doesn't exist.
You tried to add a ByteMatchSet to or delete a ByteMatchSet from a
Rule that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a
ByteMatchSet that doesn't exist.
WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFReferencedItemException - The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.public UpdateXssMatchSetResult updateXssMatchSet(UpdateXssMatchSetRequest request)
Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each
XssMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change a
XssMatchTuple, you delete the existing object and add a new one.
FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to
inspect a header, the name of the header.
TextTransformation: Which text transformation, if any, to perform on the web request before
inspecting the request for cross-site scripting attacks.
You use XssMatchSet objects to specify which CloudFront requests you want to allow, block, or count.
For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you
want to block the requests, you can create an XssMatchSet with the applicable settings, and then
configure AWS WAF to block the requests.
To create and configure an XssMatchSet, perform the following steps:
Submit a CreateXssMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of
an UpdateIPSet request.
Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to
inspect for cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
updateXssMatchSet in interface AWSWAFupdateXssMatchSetRequest - A request to update an XssMatchSet.WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account
identifier.WAFInvalidOperationException - The operation failed because there was nothing to do. For example:
You tried to remove a Rule from a WebACL, but the Rule isn't in
the specified WebACL.
You tried to remove an IP address from an IPSet, but the IP address isn't in the specified
IPSet.
You tried to remove a ByteMatchTuple from a ByteMatchSet, but the
ByteMatchTuple isn't in the specified WebACL.
You tried to add a Rule to a WebACL, but the Rule already exists
in the specified WebACL.
You tried to add an IP address to an IPSet, but the IP address already exists in the
specified IPSet.
You tried to add a ByteMatchTuple to a ByteMatchSet, but the
ByteMatchTuple already exists in the specified WebACL.
WAFInvalidParameterException - The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet, IPSet, Rule, or
WebACL) using an action other than INSERT or DELETE.
You tried to create a WebACL with a DefaultAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to create a RateBasedRule with a RateKey value other than
IP.
You tried to update a WebACL with a WafAction Type other than
ALLOW, BLOCK, or COUNT.
You tried to update a ByteMatchSet with a FieldToMatch Type other
than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet with a Field of HEADER but no
value for Data.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFNonexistentContainerException - The operation failed because you tried to add an object to or delete an object from another object that
doesn't exist. For example:
You tried to add a Rule to or delete a Rule from a WebACL that
doesn't exist.
You tried to add a ByteMatchSet to or delete a ByteMatchSet from a
Rule that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a
ByteMatchSet that doesn't exist.
WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.WAFStaleDataException - The operation failed because you tried to create, update, or delete an object by using a change token
that has already been used.WAFLimitsExceededException - The operation exceeds a resource limit, for example, the maximum number of WebACL objects
that you can create for an AWS account. For more information, see Limits in the AWS WAF
Developer Guide.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 AWSWAFrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.