com.amazonaws.services.waf

Interface AWSWAF

All Known Subinterfaces:

AWSWAFAsync

All Known Implementing Classes:

AbstractAWSWAF, AbstractAWSWAFAsync, AWSWAFAsyncClient, AWSWAFClient

public interface AWSWAF

Interface for accessing WAF.

This is the AWS WAF API Reference. 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.

Method Summary

Methods

Modifier and Type	Method and Description
CreateByteMatchSetResult	createByteMatchSet(CreateByteMatchSetRequest createByteMatchSetRequest) Creates a ByteMatchSet.
CreateIPSetResult	createIPSet(CreateIPSetRequest createIPSetRequest) Creates an IPSet, which you use to specify which web requests you want to allow or block based on the IP addresses that the requests originate from.
CreateRuleResult	createRule(CreateRuleRequest createRuleRequest) Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block.
CreateSqlInjectionMatchSetResult	createSqlInjectionMatchSet(CreateSqlInjectionMatchSetRequest createSqlInjectionMatchSetRequest) Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests.
CreateWebACLResult	createWebACL(CreateWebACLRequest createWebACLRequest) Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count.
DeleteByteMatchSetResult	deleteByteMatchSet(DeleteByteMatchSetRequest deleteByteMatchSetRequest) Permanently deletes a ByteMatchSet.
DeleteIPSetResult	deleteIPSet(DeleteIPSetRequest deleteIPSetRequest) Permanently deletes an IPSet.
DeleteRuleResult	deleteRule(DeleteRuleRequest deleteRuleRequest) Permanently deletes a Rule.
DeleteSqlInjectionMatchSetResult	deleteSqlInjectionMatchSet(DeleteSqlInjectionMatchSetRequest deleteSqlInjectionMatchSetRequest) Permanently deletes a SqlInjectionMatchSet.
DeleteWebACLResult	deleteWebACL(DeleteWebACLRequest deleteWebACLRequest) Permanently deletes a WebACL.
GetByteMatchSetResult	getByteMatchSet(GetByteMatchSetRequest getByteMatchSetRequest) Returns the ByteMatchSet specified by ByteMatchSetId.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetChangeTokenResult	getChangeToken(GetChangeTokenRequest getChangeTokenRequest) When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request.
GetChangeTokenStatusResult	getChangeTokenStatus(GetChangeTokenStatusRequest getChangeTokenStatusRequest) Returns the status of a ChangeToken that you got by calling GetChangeToken.
GetIPSetResult	getIPSet(GetIPSetRequest getIPSetRequest) Returns the IPSet that is specified by IPSetId.
GetRuleResult	getRule(GetRuleRequest getRuleRequest) Returns the Rule that is specified by the RuleId that you included in the GetRule request.
GetSampledRequestsResult	getSampledRequests(GetSampledRequestsRequest getSampledRequestsRequest) Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose.
GetSqlInjectionMatchSetResult	getSqlInjectionMatchSet(GetSqlInjectionMatchSetRequest getSqlInjectionMatchSetRequest) Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.
GetWebACLResult	getWebACL(GetWebACLRequest getWebACLRequest) Returns the WebACL that is specified by WebACLId.
ListByteMatchSetsResult	listByteMatchSets(ListByteMatchSetsRequest listByteMatchSetsRequest) Returns an array of ByteMatchSetSummary objects.
ListIPSetsResult	listIPSets(ListIPSetsRequest listIPSetsRequest) Returns an array of IPSetSummary objects in the response.
ListRulesResult	listRules(ListRulesRequest listRulesRequest) Returns an array of RuleSummary objects.
ListSqlInjectionMatchSetsResult	listSqlInjectionMatchSets(ListSqlInjectionMatchSetsRequest listSqlInjectionMatchSetsRequest) Returns an array of SqlInjectionMatchSet objects.
ListWebACLsResult	listWebACLs(ListWebACLsRequest listWebACLsRequest) Returns an array of WebACLSummary objects in the response.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://waf.amazonaws.com/").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateByteMatchSetResult	updateByteMatchSet(UpdateByteMatchSetRequest updateByteMatchSetRequest) Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet.
UpdateIPSetResult	updateIPSet(UpdateIPSetRequest updateIPSetRequest) Inserts or deletes IPSetDescriptor objects in an IPSet.
UpdateRuleResult	updateRule(UpdateRuleRequest updateRuleRequest) Inserts or deletes Predicate objects in a Rule.
UpdateSqlInjectionMatchSetResult	updateSqlInjectionMatchSet(UpdateSqlInjectionMatchSetRequest updateSqlInjectionMatchSetRequest) Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet.
UpdateWebACLResult	updateWebACL(UpdateWebACLRequest updateWebACLRequest) Inserts or deletes ActivatedRule objects in a WebACL.

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Overrides the default endpoint for this client ("https://waf.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "waf.amazonaws.com/") or a full URL, including the protocol (ex: "https://waf.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "waf.amazonaws.com/") or a full URL, including the protocol (ex: "https://waf.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

setRegion

void setRegion(Region region)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

createByteMatchSet

CreateByteMatchSetResult createByteMatchSet(CreateByteMatchSetRequest createByteMatchSetRequest)

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:

1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request.
2. Submit a CreateByteMatchSet request.
3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.
4. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameters:

createByteMatchSetRequest -

Returns:

Result of the CreateByteMatchSet operation returned by the service.

Throws:

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 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, QUERY_STRING, or URI.
• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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.

createIPSet

CreateIPSetResult createIPSet(CreateIPSetRequest createIPSetRequest)

Creates an IPSet, which you use to specify which web requests you want to allow or block based on the IP addresses that the requests originate from. 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:

1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.
2. Submit a CreateIPSet request.
3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
4. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameters:

createIPSetRequest -

Returns:

Result of the CreateIPSet operation returned by the service.

Throws:

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 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, QUERY_STRING, or URI.
• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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.

createRule

CreateRuleResult createRule(CreateRuleRequest createRuleRequest)

Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. 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:

1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.
3. Submit a CreateRule request.
4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule.
6. 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.

Parameters:

createRuleRequest -

Returns:

Result of the CreateRule operation returned by the service.

Throws:

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 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, QUERY_STRING, or URI.
• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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.

createSqlInjectionMatchSet

CreateSqlInjectionMatchSetResult createSqlInjectionMatchSet(CreateSqlInjectionMatchSetRequest createSqlInjectionMatchSetRequest)

Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure a SqlInjectionMatchSet, perform the following steps:

1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request.
2. Submit a CreateSqlInjectionMatchSet request.
3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request.
4. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameters:

createSqlInjectionMatchSetRequest - A request to create a SqlInjectionMatchSet.

Returns:

Result of the CreateSqlInjectionMatchSet operation returned by the service.

Throws:

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 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, QUERY_STRING, or URI.
• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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.

createWebACL

CreateWebACLResult createWebACL(CreateWebACLRequest createWebACLRequest)

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:

1. 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.
2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.
3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request.
4. Submit a CreateWebACL request.
5. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.
6. 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.

Parameters:

createWebACLRequest -

Returns:

Result of the CreateWebACL operation returned by the service.

Throws:

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 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, QUERY_STRING, or URI.
• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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.

deleteByteMatchSet

DeleteByteMatchSetResult deleteByteMatchSet(DeleteByteMatchSetRequest deleteByteMatchSetRequest)

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:

1. Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.
2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request.
3. Submit a DeleteByteMatchSet request.

Parameters:

deleteByteMatchSetRequest -

Returns:

Result of the DeleteByteMatchSet operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was 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.

deleteIPSet

DeleteIPSetResult deleteIPSet(DeleteIPSetRequest deleteIPSetRequest)

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:

1. Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.
2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request.
3. Submit a DeleteIPSet request.

Parameters:

deleteIPSetRequest -

Returns:

Result of the DeleteIPSet operation returned by the service.

Throws:

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.

deleteRule

DeleteRuleResult deleteRule(DeleteRuleRequest deleteRuleRequest)

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:

1. Update the Rule to remove predicates, if any. For more information, see UpdateRule.
2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request.
3. Submit a DeleteRule request.

Parameters:

deleteRuleRequest -

Returns:

Result of the DeleteRule operation returned by the service.

Throws:

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.

deleteSqlInjectionMatchSet

DeleteSqlInjectionMatchSetResult deleteSqlInjectionMatchSet(DeleteSqlInjectionMatchSetRequest deleteSqlInjectionMatchSetRequest)

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:

1. Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.
2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request.
3. Submit a DeleteSqlInjectionMatchSet request.

Parameters:

deleteSqlInjectionMatchSetRequest - A request to delete a SqlInjectionMatchSet from AWS WAF.

Returns:

Result of the DeleteSqlInjectionMatchSet operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was 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.

deleteWebACL

DeleteWebACLResult deleteWebACL(DeleteWebACLRequest deleteWebACLRequest)

Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.

To delete a WebACL, perform the following steps:

1. Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL.
2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request.
3. Submit a DeleteWebACL request.

Parameters:

deleteWebACLRequest -

Returns:

Result of the DeleteWebACL operation returned by the service.

Throws:

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.

getByteMatchSet

GetByteMatchSetResult getByteMatchSet(GetByteMatchSetRequest getByteMatchSetRequest)

Returns the ByteMatchSet specified by ByteMatchSetId.

Parameters:

getByteMatchSetRequest -

Returns:

Result of the GetByteMatchSet operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was 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.

getChangeToken

GetChangeTokenResult getChangeToken(GetChangeTokenRequest getChangeTokenRequest)

When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. 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.

Parameters:

getChangeTokenRequest -

Returns:

Result of the GetChangeToken operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.

getChangeTokenStatus

GetChangeTokenStatusResult getChangeTokenStatus(GetChangeTokenStatusRequest getChangeTokenStatusRequest)

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.

Parameters:

getChangeTokenStatusRequest -

Returns:

Result of the GetChangeTokenStatus operation returned by the service.

Throws:

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.

getIPSet

GetIPSetResult getIPSet(GetIPSetRequest getIPSetRequest)

Returns the IPSet that is specified by IPSetId.

Parameters:

getIPSetRequest -

Returns:

Result of the GetIPSet operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was 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.

getRule

GetRuleResult getRule(GetRuleRequest getRuleRequest)

Returns the Rule that is specified by the RuleId that you included in the GetRule request.

Parameters:

getRuleRequest -

Returns:

Result of the GetRule operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was 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.

getSampledRequests

GetSampledRequestsResult getSampledRequests(GetSampledRequestsRequest getSampledRequestsRequest)

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 100 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

Parameters:

getSampledRequestsRequest -

Returns:

Result of the GetSampledRequests operation returned by the service.

Throws:

WAFNonexistentItemException - The operation failed because the referenced object doesn't exist.

getSqlInjectionMatchSet

GetSqlInjectionMatchSetResult getSqlInjectionMatchSet(GetSqlInjectionMatchSetRequest getSqlInjectionMatchSetRequest)

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

Parameters:

getSqlInjectionMatchSetRequest - A request to get a SqlInjectionMatchSet.

Returns:

Result of the GetSqlInjectionMatchSet operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was 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.

getWebACL

GetWebACLResult getWebACL(GetWebACLRequest getWebACLRequest)

Returns the WebACL that is specified by WebACLId.

Parameters:

getWebACLRequest -

Returns:

Result of the GetWebACL operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was 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.

listByteMatchSets

ListByteMatchSetsResult listByteMatchSets(ListByteMatchSetsRequest listByteMatchSetsRequest)

Returns an array of ByteMatchSetSummary objects.

Parameters:

listByteMatchSetsRequest -

Returns:

Result of the ListByteMatchSets operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

listIPSets

ListIPSetsResult listIPSets(ListIPSetsRequest listIPSetsRequest)

Returns an array of IPSetSummary objects in the response.

Parameters:

listIPSetsRequest -

Returns:

Result of the ListIPSets operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

listRules

ListRulesResult listRules(ListRulesRequest listRulesRequest)

Returns an array of RuleSummary objects.

Parameters:

listRulesRequest -

Returns:

Result of the ListRules operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

listSqlInjectionMatchSets

ListSqlInjectionMatchSetsResult listSqlInjectionMatchSets(ListSqlInjectionMatchSetsRequest listSqlInjectionMatchSetsRequest)

Returns an array of SqlInjectionMatchSet objects.

Parameters:

listSqlInjectionMatchSetsRequest - A request to list the SqlInjectionMatchSet objects created by the current AWS account.

Returns:

Result of the ListSqlInjectionMatchSets operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

listWebACLs

ListWebACLsResult listWebACLs(ListWebACLsRequest listWebACLsRequest)

Returns an array of WebACLSummary objects in the response.

Parameters:

listWebACLsRequest -

Returns:

Result of the ListWebACLs operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException - The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

updateByteMatchSet

UpdateByteMatchSetResult updateByteMatchSet(UpdateByteMatchSetRequest updateByteMatchSetRequest)

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:

1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.
2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.
3. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameters:

updateByteMatchSetRequest -

Returns:

Result of the UpdateByteMatchSet operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was 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 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, QUERY_STRING, or URI.
• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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.

updateIPSet

UpdateIPSetResult updateIPSet(UpdateIPSetRequest updateIPSetRequest)

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.
• 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 more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

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:

1. Submit a CreateIPSet request.
2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
3. 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.

Parameters:

updateIPSetRequest -

Returns:

Result of the UpdateIPSet operation returned by the service.

Throws:

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 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, QUERY_STRING, or URI.
• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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.

updateRule

UpdateRuleResult updateRule(UpdateRuleRequest updateRuleRequest)

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:

1. Create and update the predicates that you want to include in the Rule.
2. Create the Rule. See CreateRule.
3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
4. Submit an UpdateRule request to add predicates to the Rule.
5. 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.

Parameters:

updateRuleRequest -

Returns:

Result of the UpdateRule operation returned by the service.

Throws:

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 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, QUERY_STRING, or URI.
• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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.

updateSqlInjectionMatchSet

UpdateSqlInjectionMatchSetResult updateSqlInjectionMatchSet(UpdateSqlInjectionMatchSetRequest updateSqlInjectionMatchSetRequest)

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:

1. Submit a CreateSqlInjectionMatchSet request.
2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameters:

updateSqlInjectionMatchSetRequest - A request to update a SqlInjectionMatchSet.

Returns:

Result of the UpdateSqlInjectionMatchSet operation returned by the service.

Throws:

WAFInternalErrorException - The operation failed because of a system problem, even though the request was 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 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, QUERY_STRING, or URI.
• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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.

updateWebACL

UpdateWebACLResult updateWebACL(UpdateWebACLRequest updateWebACLRequest)

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.
• The CloudFront distribution that you want to associate with the WebACL.

To create and configure a WebACL, perform the following steps:

1. Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.
3. Create a WebACL. See CreateWebACL.
4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.
5. 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 to allow or block HTTP requests, see the AWS WAF Developer Guide.

Parameters:

updateWebACLRequest -

Returns:

Result of the UpdateWebACL operation returned by the service.

Throws:

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 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, QUERY_STRING, or URI.
• You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.