# AWS WAF Classic Regional
The following actions are supported by AWS WAF Classic Regional:
+ [AssociateWebACL](API_wafRegional_AssociateWebACL.md)
+ [CreateByteMatchSet](API_wafRegional_CreateByteMatchSet.md)
+ [CreateGeoMatchSet](API_wafRegional_CreateGeoMatchSet.md)
+ [CreateIPSet](API_wafRegional_CreateIPSet.md)
+ [CreateRateBasedRule](API_wafRegional_CreateRateBasedRule.md)
+ [CreateRegexMatchSet](API_wafRegional_CreateRegexMatchSet.md)
+ [CreateRegexPatternSet](API_wafRegional_CreateRegexPatternSet.md)
+ [CreateRule](API_wafRegional_CreateRule.md)
+ [CreateRuleGroup](API_wafRegional_CreateRuleGroup.md)
+ [CreateSizeConstraintSet](API_wafRegional_CreateSizeConstraintSet.md)
+ [CreateSqlInjectionMatchSet](API_wafRegional_CreateSqlInjectionMatchSet.md)
+ [CreateWebACL](API_wafRegional_CreateWebACL.md)
+ [CreateWebACLMigrationStack](API_wafRegional_CreateWebACLMigrationStack.md)
+ [CreateXssMatchSet](API_wafRegional_CreateXssMatchSet.md)
+ [DeleteByteMatchSet](API_wafRegional_DeleteByteMatchSet.md)
+ [DeleteGeoMatchSet](API_wafRegional_DeleteGeoMatchSet.md)
+ [DeleteIPSet](API_wafRegional_DeleteIPSet.md)
+ [DeleteLoggingConfiguration](API_wafRegional_DeleteLoggingConfiguration.md)
+ [DeletePermissionPolicy](API_wafRegional_DeletePermissionPolicy.md)
+ [DeleteRateBasedRule](API_wafRegional_DeleteRateBasedRule.md)
+ [DeleteRegexMatchSet](API_wafRegional_DeleteRegexMatchSet.md)
+ [DeleteRegexPatternSet](API_wafRegional_DeleteRegexPatternSet.md)
+ [DeleteRule](API_wafRegional_DeleteRule.md)
+ [DeleteRuleGroup](API_wafRegional_DeleteRuleGroup.md)
+ [DeleteSizeConstraintSet](API_wafRegional_DeleteSizeConstraintSet.md)
+ [DeleteSqlInjectionMatchSet](API_wafRegional_DeleteSqlInjectionMatchSet.md)
+ [DeleteWebACL](API_wafRegional_DeleteWebACL.md)
+ [DeleteXssMatchSet](API_wafRegional_DeleteXssMatchSet.md)
+ [DisassociateWebACL](API_wafRegional_DisassociateWebACL.md)
+ [GetByteMatchSet](API_wafRegional_GetByteMatchSet.md)
+ [GetChangeToken](API_wafRegional_GetChangeToken.md)
+ [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md)
+ [GetGeoMatchSet](API_wafRegional_GetGeoMatchSet.md)
+ [GetIPSet](API_wafRegional_GetIPSet.md)
+ [GetLoggingConfiguration](API_wafRegional_GetLoggingConfiguration.md)
+ [GetPermissionPolicy](API_wafRegional_GetPermissionPolicy.md)
+ [GetRateBasedRule](API_wafRegional_GetRateBasedRule.md)
+ [GetRateBasedRuleManagedKeys](API_wafRegional_GetRateBasedRuleManagedKeys.md)
+ [GetRegexMatchSet](API_wafRegional_GetRegexMatchSet.md)
+ [GetRegexPatternSet](API_wafRegional_GetRegexPatternSet.md)
+ [GetRule](API_wafRegional_GetRule.md)
+ [GetRuleGroup](API_wafRegional_GetRuleGroup.md)
+ [GetSampledRequests](API_wafRegional_GetSampledRequests.md)
+ [GetSizeConstraintSet](API_wafRegional_GetSizeConstraintSet.md)
+ [GetSqlInjectionMatchSet](API_wafRegional_GetSqlInjectionMatchSet.md)
+ [GetWebACL](API_wafRegional_GetWebACL.md)
+ [GetWebACLForResource](API_wafRegional_GetWebACLForResource.md)
+ [GetXssMatchSet](API_wafRegional_GetXssMatchSet.md)
+ [ListActivatedRulesInRuleGroup](API_wafRegional_ListActivatedRulesInRuleGroup.md)
+ [ListByteMatchSets](API_wafRegional_ListByteMatchSets.md)
+ [ListGeoMatchSets](API_wafRegional_ListGeoMatchSets.md)
+ [ListIPSets](API_wafRegional_ListIPSets.md)
+ [ListLoggingConfigurations](API_wafRegional_ListLoggingConfigurations.md)
+ [ListRateBasedRules](API_wafRegional_ListRateBasedRules.md)
+ [ListRegexMatchSets](API_wafRegional_ListRegexMatchSets.md)
+ [ListRegexPatternSets](API_wafRegional_ListRegexPatternSets.md)
+ [ListResourcesForWebACL](API_wafRegional_ListResourcesForWebACL.md)
+ [ListRuleGroups](API_wafRegional_ListRuleGroups.md)
+ [ListRules](API_wafRegional_ListRules.md)
+ [ListSizeConstraintSets](API_wafRegional_ListSizeConstraintSets.md)
+ [ListSqlInjectionMatchSets](API_wafRegional_ListSqlInjectionMatchSets.md)
+ [ListSubscribedRuleGroups](API_wafRegional_ListSubscribedRuleGroups.md)
+ [ListTagsForResource](API_wafRegional_ListTagsForResource.md)
+ [ListWebACLs](API_wafRegional_ListWebACLs.md)
+ [ListXssMatchSets](API_wafRegional_ListXssMatchSets.md)
+ [PutLoggingConfiguration](API_wafRegional_PutLoggingConfiguration.md)
+ [PutPermissionPolicy](API_wafRegional_PutPermissionPolicy.md)
+ [TagResource](API_wafRegional_TagResource.md)
+ [UntagResource](API_wafRegional_UntagResource.md)
+ [UpdateByteMatchSet](API_wafRegional_UpdateByteMatchSet.md)
+ [UpdateGeoMatchSet](API_wafRegional_UpdateGeoMatchSet.md)
+ [UpdateIPSet](API_wafRegional_UpdateIPSet.md)
+ [UpdateRateBasedRule](API_wafRegional_UpdateRateBasedRule.md)
+ [UpdateRegexMatchSet](API_wafRegional_UpdateRegexMatchSet.md)
+ [UpdateRegexPatternSet](API_wafRegional_UpdateRegexPatternSet.md)
+ [UpdateRule](API_wafRegional_UpdateRule.md)
+ [UpdateRuleGroup](API_wafRegional_UpdateRuleGroup.md)
+ [UpdateSizeConstraintSet](API_wafRegional_UpdateSizeConstraintSet.md)
+ [UpdateSqlInjectionMatchSet](API_wafRegional_UpdateSqlInjectionMatchSet.md)
+ [UpdateWebACL](API_wafRegional_UpdateWebACL.md)
+ [UpdateXssMatchSet](API_wafRegional_UpdateXssMatchSet.md)
# AssociateWebACL
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Associates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage.
## Request Syntax
```
{
"ResourceArn": "string",
"WebACLId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceArn](#API_wafRegional_AssociateWebACL_RequestSyntax) **
The ARN (Amazon Resource Name) of the resource to be protected, either an application load balancer or Amazon API Gateway stage.
The ARN should be in one of the following formats:
+ For an Application Load Balancer: `arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id `
+ For an Amazon API Gateway stage: `arn:aws:apigateway:region::/restapis/api-id/stages/stage-name `
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: Yes
** [WebACLId](#API_wafRegional_AssociateWebACL_RequestSyntax) **
A unique identifier (ID) for the web ACL.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFUnavailableEntityException **
The operation failed because the entity referenced is temporarily unavailable. Retry your request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/AssociateWebACL)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/AssociateWebACL)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/AssociateWebACL)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/AssociateWebACL)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/AssociateWebACL)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/AssociateWebACL)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/AssociateWebACL)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/AssociateWebACL)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/AssociateWebACL)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/AssociateWebACL)
# CreateByteMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a `ByteMatchSet`. You then use [UpdateByteMatchSet](API_wafRegional_UpdateByteMatchSet.md) 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](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `CreateByteMatchSet` request.
1. Submit a `CreateByteMatchSet` request.
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an `UpdateByteMatchSet` request.
1. Submit an [UpdateByteMatchSet](API_wafRegional_UpdateByteMatchSet.md) request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI path) 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"Name": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_CreateByteMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_wafRegional_CreateByteMatchSet_RequestSyntax) **
A friendly name or description of the [ByteMatchSet](API_wafRegional_ByteMatchSet.md). You can't change `Name` after you create a `ByteMatchSet`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ByteMatchSet": {
"ByteMatchSetId": "string",
"ByteMatchTuples": [
{
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"PositionalConstraint": "string",
"TargetString": blob,
"TextTransformation": "string"
}
],
"Name": "string"
},
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ByteMatchSet](#API_wafRegional_CreateByteMatchSet_ResponseSyntax) **
A [ByteMatchSet](API_wafRegional_ByteMatchSet.md) that contains no `ByteMatchTuple` objects.
Type: [ByteMatchSet](API_wafRegional_ByteMatchSet.md) object
** [ChangeToken](#API_wafRegional_CreateByteMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `CreateByteMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateByteMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateByteMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateByteMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateByteMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateByteMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateByteMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateByteMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateByteMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateByteMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateByteMatchSet)
# CreateGeoMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates an [GeoMatchSet](API_wafRegional_GeoMatchSet.md), 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:
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `CreateGeoMatchSet` request.
1. Submit a `CreateGeoMatchSet` request.
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an [UpdateGeoMatchSet](API_wafRegional_UpdateGeoMatchSet.md) request.
1. 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"Name": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_CreateGeoMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_wafRegional_CreateGeoMatchSet_RequestSyntax) **
A friendly name or description of the [GeoMatchSet](API_wafRegional_GeoMatchSet.md). You can't change `Name` after you create the `GeoMatchSet`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string",
"GeoMatchSet": {
"GeoMatchConstraints": [
{
"Type": "string",
"Value": "string"
}
],
"GeoMatchSetId": "string",
"Name": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_CreateGeoMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `CreateGeoMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
** [GeoMatchSet](#API_wafRegional_CreateGeoMatchSet_ResponseSyntax) **
The [GeoMatchSet](API_wafRegional_GeoMatchSet.md) returned in the `CreateGeoMatchSet` response. The `GeoMatchSet` contains no `GeoMatchConstraints`.
Type: [GeoMatchSet](API_wafRegional_GeoMatchSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateGeoMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateGeoMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateGeoMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateGeoMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateGeoMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateGeoMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateGeoMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateGeoMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateGeoMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateGeoMatchSet)
# CreateIPSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates an [IPSet](API_wafRegional_IPSet.md), which you use to specify which web requests that 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](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `CreateIPSet` request.
1. Submit a `CreateIPSet` request.
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an [UpdateIPSet](API_wafRegional_UpdateIPSet.md) request.
1. 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"Name": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_CreateIPSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_wafRegional_CreateIPSet_RequestSyntax) **
A friendly name or description of the [IPSet](API_wafRegional_IPSet.md). You can't change `Name` after you create the `IPSet`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string",
"IPSet": {
"IPSetDescriptors": [
{
"Type": "string",
"Value": "string"
}
],
"IPSetId": "string",
"Name": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_CreateIPSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `CreateIPSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
** [IPSet](#API_wafRegional_CreateIPSet_ResponseSyntax) **
The [IPSet](API_wafRegional_IPSet.md) returned in the `CreateIPSet` response.
Type: [IPSet](API_wafRegional_IPSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateIPSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateIPSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateIPSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateIPSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateIPSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateIPSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateIPSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateIPSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateIPSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateIPSet)
# CreateRateBasedRule
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a [RateBasedRule](API_wafRegional_RateBasedRule.md). 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 conditions 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 1,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 1,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 1,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 1,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:
1. Create and update the predicates that you want to include in the rule. For more information, see [CreateByteMatchSet](API_wafRegional_CreateByteMatchSet.md), [CreateIPSet](API_wafRegional_CreateIPSet.md), and [CreateSqlInjectionMatchSet](API_wafRegional_CreateSqlInjectionMatchSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `CreateRule` request.
1. Submit a `CreateRateBasedRule` request.
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an [UpdateRule](API_wafRegional_UpdateRule.md) request.
1. Submit an `UpdateRateBasedRule` request to specify the predicates that you want to include in the rule.
1. Create and update a `WebACL` that contains the `RateBasedRule`. For more information, see [CreateWebACL](API_wafRegional_CreateWebACL.md).
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"MetricName": "string",
"Name": "string",
"RateKey": "string",
"RateLimit": number,
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_CreateRateBasedRule_RequestSyntax) **
The `ChangeToken` that you used to submit the `CreateRateBasedRule` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [MetricName](#API_wafRegional_CreateRateBasedRule_RequestSyntax) **
A friendly name or description for the metrics for this `RateBasedRule`. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default\$1Action." You can't change the name of the metric after you create the `RateBasedRule`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_wafRegional_CreateRateBasedRule_RequestSyntax) **
A friendly name or description of the [RateBasedRule](API_wafRegional_RateBasedRule.md). You can't change the name of a `RateBasedRule` after you create it.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [RateKey](#API_wafRegional_CreateRateBasedRule_RequestSyntax) **
The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for `RateKey` is `IP`. `IP` indicates that requests that arrive from the same IP address are subject to the `RateLimit` that is specified in the `RateBasedRule`.
Type: String
Valid Values: `IP`
Required: Yes
** [RateLimit](#API_wafRegional_CreateRateBasedRule_RequestSyntax) **
The maximum number of requests, which have an identical value in the field that is specified by `RateKey`, allowed in a five-minute period. If the number of requests exceeds the `RateLimit` and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
Type: Long
Valid Range: Minimum value of 100. Maximum value of 2000000000.
Required: Yes
** [Tags](#API_wafRegional_CreateRateBasedRule_RequestSyntax) **
Type: Array of [Tag](API_wafRegional_Tag.md) objects
Array Members: Minimum number of 1 item.
Required: No
## Response Syntax
```
{
"ChangeToken": "string",
"Rule": {
"MatchPredicates": [
{
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
],
"MetricName": "string",
"Name": "string",
"RateKey": "string",
"RateLimit": number,
"RuleId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_CreateRateBasedRule_ResponseSyntax) **
The `ChangeToken` that you used to submit the `CreateRateBasedRule` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
** [Rule](#API_wafRegional_CreateRateBasedRule_ResponseSyntax) **
The [RateBasedRule](API_wafRegional_RateBasedRule.md) that is returned in the `CreateRateBasedRule` response.
Type: [RateBasedRule](API_wafRegional_RateBasedRule.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFBadRequestException **
HTTP Status Code: 400
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
** WAFTagOperationException **
HTTP Status Code: 400
** WAFTagOperationInternalErrorException **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateRateBasedRule)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateRateBasedRule)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateRateBasedRule)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateRateBasedRule)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateRateBasedRule)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateRateBasedRule)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateRateBasedRule)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateRateBasedRule)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateRateBasedRule)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateRateBasedRule)
# CreateRegexMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a [RegexMatchSet](API_wafRegional_RegexMatchSet.md). You then use [UpdateRegexMatchSet](API_wafRegional_UpdateRegexMatchSet.md) 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:
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `CreateRegexMatchSet` request.
1. Submit a `CreateRegexMatchSet` request.
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an `UpdateRegexMatchSet` request.
1. Submit an [UpdateRegexMatchSet](API_wafRegional_UpdateRegexMatchSet.md) request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI path) 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"Name": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_CreateRegexMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_wafRegional_CreateRegexMatchSet_RequestSyntax) **
A friendly name or description of the [RegexMatchSet](API_wafRegional_RegexMatchSet.md). You can't change `Name` after you create a `RegexMatchSet`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string",
"RegexMatchSet": {
"Name": "string",
"RegexMatchSetId": "string",
"RegexMatchTuples": [
{
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"RegexPatternSetId": "string",
"TextTransformation": "string"
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_CreateRegexMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `CreateRegexMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
** [RegexMatchSet](#API_wafRegional_CreateRegexMatchSet_ResponseSyntax) **
A [RegexMatchSet](API_wafRegional_RegexMatchSet.md) that contains no `RegexMatchTuple` objects.
Type: [RegexMatchSet](API_wafRegional_RegexMatchSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateRegexMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateRegexMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateRegexMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateRegexMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateRegexMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateRegexMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateRegexMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateRegexMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateRegexMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateRegexMatchSet)
# CreateRegexPatternSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a `RegexPatternSet`. You then use [UpdateRegexPatternSet](API_wafRegional_UpdateRegexPatternSet.md) 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:
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `CreateRegexPatternSet` request.
1. Submit a `CreateRegexPatternSet` request.
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an `UpdateRegexPatternSet` request.
1. Submit an [UpdateRegexPatternSet](API_wafRegional_UpdateRegexPatternSet.md) 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"Name": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_CreateRegexPatternSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_wafRegional_CreateRegexPatternSet_RequestSyntax) **
A friendly name or description of the [RegexPatternSet](API_wafRegional_RegexPatternSet.md). You can't change `Name` after you create a `RegexPatternSet`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string",
"RegexPatternSet": {
"Name": "string",
"RegexPatternSetId": "string",
"RegexPatternStrings": [ "string" ]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_CreateRegexPatternSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `CreateRegexPatternSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
** [RegexPatternSet](#API_wafRegional_CreateRegexPatternSet_ResponseSyntax) **
A [RegexPatternSet](API_wafRegional_RegexPatternSet.md) that contains no objects.
Type: [RegexPatternSet](API_wafRegional_RegexPatternSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateRegexPatternSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateRegexPatternSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateRegexPatternSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateRegexPatternSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateRegexPatternSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateRegexPatternSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateRegexPatternSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateRegexPatternSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateRegexPatternSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateRegexPatternSet)
# CreateRule
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
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 that 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](API_wafRegional_CreateByteMatchSet.md), [CreateIPSet](API_wafRegional_CreateIPSet.md), and [CreateSqlInjectionMatchSet](API_wafRegional_CreateSqlInjectionMatchSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `CreateRule` request.
1. Submit a `CreateRule` request.
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an [UpdateRule](API_wafRegional_UpdateRule.md) request.
1. Submit an `UpdateRule` request to specify the predicates that you want to include in the `Rule`.
1. Create and update a `WebACL` that contains the `Rule`. For more information, see [CreateWebACL](API_wafRegional_CreateWebACL.md).
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"MetricName": "string",
"Name": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_CreateRule_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [MetricName](#API_wafRegional_CreateRule_RequestSyntax) **
A friendly name or description for the metrics for this `Rule`. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default\$1Action." You can't change the name of the metric after you create the `Rule`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_wafRegional_CreateRule_RequestSyntax) **
A friendly name or description of the [Rule](API_wafRegional_Rule.md). You can't change the name of a `Rule` after you create it.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Tags](#API_wafRegional_CreateRule_RequestSyntax) **
Type: Array of [Tag](API_wafRegional_Tag.md) objects
Array Members: Minimum number of 1 item.
Required: No
## Response Syntax
```
{
"ChangeToken": "string",
"Rule": {
"MetricName": "string",
"Name": "string",
"Predicates": [
{
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
],
"RuleId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_CreateRule_ResponseSyntax) **
The `ChangeToken` that you used to submit the `CreateRule` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
** [Rule](#API_wafRegional_CreateRule_ResponseSyntax) **
The [Rule](API_wafRegional_Rule.md) returned in the `CreateRule` response.
Type: [Rule](API_wafRegional_Rule.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFBadRequestException **
HTTP Status Code: 400
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
** WAFTagOperationException **
HTTP Status Code: 400
** WAFTagOperationInternalErrorException **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateRule)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateRule)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateRule)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateRule)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateRule)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateRule)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateRule)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateRule)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateRule)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateRule)
# CreateRuleGroup
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a `RuleGroup`. A rule group is a collection of predefined rules that you add to a web ACL. You use [UpdateRuleGroup](API_wafRegional_UpdateRuleGroup.md) to add rules to the rule group.
Rule groups are subject to the following limits:
+ Three rule groups per account. You can request an increase to this limit by contacting customer support.
+ One rule group per web ACL.
+ Ten rules per rule group.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"MetricName": "string",
"Name": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_CreateRuleGroup_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [MetricName](#API_wafRegional_CreateRuleGroup_RequestSyntax) **
A friendly name or description for the metrics for this `RuleGroup`. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default\$1Action." You can't change the name of the metric after you create the `RuleGroup`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_wafRegional_CreateRuleGroup_RequestSyntax) **
A friendly name or description of the [RuleGroup](API_wafRegional_RuleGroup.md). You can't change `Name` after you create a `RuleGroup`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Tags](#API_wafRegional_CreateRuleGroup_RequestSyntax) **
Type: Array of [Tag](API_wafRegional_Tag.md) objects
Array Members: Minimum number of 1 item.
Required: No
## Response Syntax
```
{
"ChangeToken": "string",
"RuleGroup": {
"MetricName": "string",
"Name": "string",
"RuleGroupId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_CreateRuleGroup_ResponseSyntax) **
The `ChangeToken` that you used to submit the `CreateRuleGroup` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
** [RuleGroup](#API_wafRegional_CreateRuleGroup_ResponseSyntax) **
An empty [RuleGroup](API_wafRegional_RuleGroup.md).
Type: [RuleGroup](API_wafRegional_RuleGroup.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFBadRequestException **
HTTP Status Code: 400
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
** WAFTagOperationException **
HTTP Status Code: 400
** WAFTagOperationInternalErrorException **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateRuleGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateRuleGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateRuleGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateRuleGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateRuleGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateRuleGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateRuleGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateRuleGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateRuleGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateRuleGroup)
# CreateSizeConstraintSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a `SizeConstraintSet`. You then use [UpdateSizeConstraintSet](API_wafRegional_UpdateSizeConstraintSet.md) 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:
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `CreateSizeConstraintSet` request.
1. Submit a `CreateSizeConstraintSet` request.
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an `UpdateSizeConstraintSet` request.
1. Submit an [UpdateSizeConstraintSet](API_wafRegional_UpdateSizeConstraintSet.md) request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI path) 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"Name": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_CreateSizeConstraintSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_wafRegional_CreateSizeConstraintSet_RequestSyntax) **
A friendly name or description of the [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md). You can't change `Name` after you create a `SizeConstraintSet`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string",
"SizeConstraintSet": {
"Name": "string",
"SizeConstraints": [
{
"ComparisonOperator": "string",
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"Size": number,
"TextTransformation": "string"
}
],
"SizeConstraintSetId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_CreateSizeConstraintSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `CreateSizeConstraintSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
** [SizeConstraintSet](#API_wafRegional_CreateSizeConstraintSet_ResponseSyntax) **
A [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md) that contains no `SizeConstraint` objects.
Type: [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateSizeConstraintSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateSizeConstraintSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateSizeConstraintSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateSizeConstraintSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateSizeConstraintSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateSizeConstraintSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateSizeConstraintSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateSizeConstraintSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateSizeConstraintSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateSizeConstraintSet)
# CreateSqlInjectionMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md), 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](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `CreateSqlInjectionMatchSet` request.
1. Submit a `CreateSqlInjectionMatchSet` request.
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an [UpdateSqlInjectionMatchSet](API_wafRegional_UpdateSqlInjectionMatchSet.md) request.
1. Submit an [UpdateSqlInjectionMatchSet](API_wafRegional_UpdateSqlInjectionMatchSet.md) 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"Name": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_CreateSqlInjectionMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_wafRegional_CreateSqlInjectionMatchSet_RequestSyntax) **
A friendly name or description for the [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md) that you're creating. You can't change `Name` after you create the `SqlInjectionMatchSet`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string",
"SqlInjectionMatchSet": {
"Name": "string",
"SqlInjectionMatchSetId": "string",
"SqlInjectionMatchTuples": [
{
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"TextTransformation": "string"
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_CreateSqlInjectionMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `CreateSqlInjectionMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
** [SqlInjectionMatchSet](#API_wafRegional_CreateSqlInjectionMatchSet_ResponseSyntax) **
A [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md).
Type: [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateSqlInjectionMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateSqlInjectionMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateSqlInjectionMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateSqlInjectionMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateSqlInjectionMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateSqlInjectionMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateSqlInjectionMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateSqlInjectionMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateSqlInjectionMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateSqlInjectionMatchSet)
# CreateWebACL
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a `WebACL`, which contains the `Rules` that identify the Amazon 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](API_wafRegional_CreateByteMatchSet.md), [UpdateByteMatchSet](API_wafRegional_UpdateByteMatchSet.md), [CreateIPSet](API_wafRegional_CreateIPSet.md), [UpdateIPSet](API_wafRegional_UpdateIPSet.md), [CreateSqlInjectionMatchSet](API_wafRegional_CreateSqlInjectionMatchSet.md), and [UpdateSqlInjectionMatchSet](API_wafRegional_UpdateSqlInjectionMatchSet.md).
1. Create and update the `Rules` that you want to include in the `WebACL`. For more information, see [CreateRule](API_wafRegional_CreateRule.md) and [UpdateRule](API_wafRegional_UpdateRule.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `CreateWebACL` request.
1. Submit a `CreateWebACL` request.
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an [UpdateWebACL](API_wafRegional_UpdateWebACL.md) request.
1. Submit an [UpdateWebACL](API_wafRegional_UpdateWebACL.md) request to specify the `Rules` that you want to include in the `WebACL`, to specify the default action, and to associate the `WebACL` with an Amazon CloudFront distribution.
For more information about how to use the AWS WAF API, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"DefaultAction": {
"Type": "string"
},
"MetricName": "string",
"Name": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_CreateWebACL_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [DefaultAction](#API_wafRegional_CreateWebACL_RequestSyntax) **
The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the `Rule` objects that are associated with the `WebACL`.
Type: [WafAction](API_wafRegional_WafAction.md) object
Required: Yes
** [MetricName](#API_wafRegional_CreateWebACL_RequestSyntax) **
A friendly name or description for the metrics for this `WebACL`.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default\$1Action." You can't change `MetricName` after you create the `WebACL`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_wafRegional_CreateWebACL_RequestSyntax) **
A friendly name or description of the [WebACL](API_wafRegional_WebACL.md). You can't change `Name` after you create the `WebACL`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Tags](#API_wafRegional_CreateWebACL_RequestSyntax) **
Type: Array of [Tag](API_wafRegional_Tag.md) objects
Array Members: Minimum number of 1 item.
Required: No
## Response Syntax
```
{
"ChangeToken": "string",
"WebACL": {
"DefaultAction": {
"Type": "string"
},
"MetricName": "string",
"Name": "string",
"Rules": [
{
"Action": {
"Type": "string"
},
"ExcludedRules": [
{
"RuleId": "string"
}
],
"OverrideAction": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
],
"WebACLArn": "string",
"WebACLId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_CreateWebACL_ResponseSyntax) **
The `ChangeToken` that you used to submit the `CreateWebACL` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
** [WebACL](#API_wafRegional_CreateWebACL_ResponseSyntax) **
The [WebACL](API_wafRegional_WebACL.md) returned in the `CreateWebACL` response.
Type: [WebACL](API_wafRegional_WebACL.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFBadRequestException **
HTTP Status Code: 400
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
** WAFTagOperationException **
HTTP Status Code: 400
** WAFTagOperationInternalErrorException **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateWebACL)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateWebACL)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateWebACL)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateWebACL)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateWebACL)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateWebACL)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateWebACL)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateWebACL)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateWebACL)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateWebACL)
# CreateWebACLMigrationStack
Creates an AWS CloudFormation AWS WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see [Migrating your AWS WAF Classic resources to AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-migrating-from-classic.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
## Request Syntax
```
{
"IgnoreUnsupportedType": boolean,
"S3BucketName": "string",
"WebACLId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [IgnoreUnsupportedType](#API_wafRegional_CreateWebACLMigrationStack_RequestSyntax) **
Indicates whether to exclude entities that can't be migrated or to stop the migration. Set this to true to ignore unsupported entities in the web ACL during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the process and throws an exception.
Type: Boolean
Required: Yes
** [S3BucketName](#API_wafRegional_CreateWebACLMigrationStack_RequestSyntax) **
The name of the Amazon S3 bucket to store the AWS CloudFormation template in. The S3 bucket must be configured as follows for the migration:
+ If the bucket is encrypted, the encryption must use Amazon S3 (SSE-S3) keys. The migration doesn't support encryption with AWS Key Management Service (SSE-KMS) keys.
+ The bucket name must start with `aws-waf-migration-`. For example, `aws-waf-migration-my-web-acl`.
+ The bucket must be in the Region where you are deploying the template. For example, for a web ACL in `us-west-2`, you must use an Amazon S3 bucket in `us-west-2` and you must deploy the template stack to `us-west-2`.
+ The bucket policies must permit the migration process to write data. For listings of the bucket policies, see the Examples section.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: `^aws-waf-migration-[0-9A-Za-z\.\-_]*`
Required: Yes
** [WebACLId](#API_wafRegional_CreateWebACLMigrationStack_RequestSyntax) **
The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"S3ObjectUrl": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [S3ObjectUrl](#API_wafRegional_CreateWebACLMigrationStack_ResponseSyntax) **
The URL of the template created in Amazon S3.
Type: String
Length Constraints: Minimum length of 1.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFEntityMigrationException **
The operation failed due to a problem with the migration. The failure cause is provided in the exception, in the `MigrationErrorType`:
+ `ENTITY_NOT_SUPPORTED` - The web ACL has an unsupported entity but the `IgnoreUnsupportedType` is not set to true.
+ `ENTITY_NOT_FOUND` - The web ACL doesn't exist.
+ `S3_BUCKET_NO_PERMISSION` - You don't have permission to perform the `PutObject` action to the specified Amazon S3 bucket.
+ `S3_BUCKET_NOT_ACCESSIBLE` - The bucket policy doesn't allow AWS WAF to perform the `PutObject` action in the bucket.
+ `S3_BUCKET_NOT_FOUND` - The S3 bucket doesn't exist.
+ `S3_BUCKET_INVALID_REGION` - The S3 bucket is not in the same Region as the web ACL.
+ `S3_INTERNAL_ERROR` - AWS WAF failed to create the template in the S3 bucket for another reason.
In addition, the exception includes specific details about the failure in the `MigrationErrorReason`.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## Examples
### Amazon S3 bucket policy for global Amazon CloudFront applications
This example illustrates one usage of CreateWebACLMigrationStack.
```
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "apiv2migration.waf.amazonaws.com"
},
"Action": "s3:PutObject",
"Resource": "arn:aws:s3:::/AWSWAF//*"
}
]
}
```
### Amazon S3 bucket policy for Amazon API Gateway API or Application Load Balancer applications
This example illustrates one usage of CreateWebACLMigrationStack.
```
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "apiv2migration.waf-regional.amazonaws.com"
},
"Action": "s3:PutObject",
"Resource": "arn:aws:s3:::/AWSWAF//*"
}
]
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateWebACLMigrationStack)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateWebACLMigrationStack)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateWebACLMigrationStack)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateWebACLMigrationStack)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateWebACLMigrationStack)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateWebACLMigrationStack)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateWebACLMigrationStack)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateWebACLMigrationStack)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateWebACLMigrationStack)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateWebACLMigrationStack)
# CreateXssMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates an [XssMatchSet](API_wafRegional_XssMatchSet.md), 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:
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `CreateXssMatchSet` request.
1. Submit a `CreateXssMatchSet` request.
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an [UpdateXssMatchSet](API_wafRegional_UpdateXssMatchSet.md) request.
1. Submit an [UpdateXssMatchSet](API_wafRegional_UpdateXssMatchSet.md) 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"Name": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_CreateXssMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_wafRegional_CreateXssMatchSet_RequestSyntax) **
A friendly name or description for the [XssMatchSet](API_wafRegional_XssMatchSet.md) that you're creating. You can't change `Name` after you create the `XssMatchSet`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string",
"XssMatchSet": {
"Name": "string",
"XssMatchSetId": "string",
"XssMatchTuples": [
{
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"TextTransformation": "string"
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_CreateXssMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `CreateXssMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
** [XssMatchSet](#API_wafRegional_CreateXssMatchSet_ResponseSyntax) **
An [XssMatchSet](API_wafRegional_XssMatchSet.md).
Type: [XssMatchSet](API_wafRegional_XssMatchSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/CreateXssMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/CreateXssMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/CreateXssMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/CreateXssMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/CreateXssMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/CreateXssMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/CreateXssMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/CreateXssMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/CreateXssMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/CreateXssMatchSet)
# DeleteByteMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a [ByteMatchSet](API_wafRegional_ByteMatchSet.md). You can't delete a `ByteMatchSet` if it's still used in any `Rules` or if it still includes any [ByteMatchTuple](API_wafRegional_ByteMatchTuple.md) objects (any filters).
If you just want to remove a `ByteMatchSet` from a `Rule`, use [UpdateRule](API_wafRegional_UpdateRule.md).
To permanently delete a `ByteMatchSet`, perform the following steps:
1. Update the `ByteMatchSet` to remove filters, if any. For more information, see [UpdateByteMatchSet](API_wafRegional_UpdateByteMatchSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `DeleteByteMatchSet` request.
1. Submit a `DeleteByteMatchSet` request.
## Request Syntax
```
{
"ByteMatchSetId": "string",
"ChangeToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ByteMatchSetId](#API_wafRegional_DeleteByteMatchSet_RequestSyntax) **
The `ByteMatchSetId` of the [ByteMatchSet](API_wafRegional_ByteMatchSet.md) that you want to delete. `ByteMatchSetId` is returned by [CreateByteMatchSet](API_wafRegional_CreateByteMatchSet.md) and by [ListByteMatchSets](API_wafRegional_ListByteMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [ChangeToken](#API_wafRegional_DeleteByteMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_DeleteByteMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `DeleteByteMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteByteMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteByteMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteByteMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteByteMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteByteMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteByteMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteByteMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteByteMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteByteMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteByteMatchSet)
# DeleteGeoMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a [GeoMatchSet](API_wafRegional_GeoMatchSet.md). 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](API_wafRegional_UpdateRule.md).
To permanently delete a `GeoMatchSet` from AWS WAF, perform the following steps:
1. Update the `GeoMatchSet` to remove any countries. For more information, see [UpdateGeoMatchSet](API_wafRegional_UpdateGeoMatchSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `DeleteGeoMatchSet` request.
1. Submit a `DeleteGeoMatchSet` request.
## Request Syntax
```
{
"ChangeToken": "string",
"GeoMatchSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_DeleteGeoMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [GeoMatchSetId](#API_wafRegional_DeleteGeoMatchSet_RequestSyntax) **
The `GeoMatchSetID` of the [GeoMatchSet](API_wafRegional_GeoMatchSet.md) that you want to delete. `GeoMatchSetId` is returned by [CreateGeoMatchSet](API_wafRegional_CreateGeoMatchSet.md) and by [ListGeoMatchSets](API_wafRegional_ListGeoMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_DeleteGeoMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `DeleteGeoMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteGeoMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteGeoMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteGeoMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteGeoMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteGeoMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteGeoMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteGeoMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteGeoMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteGeoMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteGeoMatchSet)
# DeleteIPSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes an [IPSet](API_wafRegional_IPSet.md). 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](API_wafRegional_UpdateRule.md).
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](API_wafRegional_UpdateIPSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `DeleteIPSet` request.
1. Submit a `DeleteIPSet` request.
## Request Syntax
```
{
"ChangeToken": "string",
"IPSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_DeleteIPSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [IPSetId](#API_wafRegional_DeleteIPSet_RequestSyntax) **
The `IPSetId` of the [IPSet](API_wafRegional_IPSet.md) that you want to delete. `IPSetId` is returned by [CreateIPSet](API_wafRegional_CreateIPSet.md) and by [ListIPSets](API_wafRegional_ListIPSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_DeleteIPSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `DeleteIPSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteIPSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteIPSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteIPSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteIPSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteIPSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteIPSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteIPSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteIPSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteIPSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteIPSet)
# DeleteLoggingConfiguration
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes the [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md) from the specified web ACL.
## Request Syntax
```
{
"ResourceArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceArn](#API_wafRegional_DeleteLoggingConfiguration_RequestSyntax) **
The Amazon Resource Name (ARN) of the web ACL from which you want to delete the [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteLoggingConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteLoggingConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteLoggingConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteLoggingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteLoggingConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteLoggingConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteLoggingConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteLoggingConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteLoggingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteLoggingConfiguration)
# DeletePermissionPolicy
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes an IAM policy from the specified RuleGroup.
The user making the request must be the owner of the RuleGroup.
## Request Syntax
```
{
"ResourceArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceArn](#API_wafRegional_DeletePermissionPolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy.
The user making the request must be the owner of the RuleGroup.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeletePermissionPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeletePermissionPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeletePermissionPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeletePermissionPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeletePermissionPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeletePermissionPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeletePermissionPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeletePermissionPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeletePermissionPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeletePermissionPolicy)
# DeleteRateBasedRule
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a [RateBasedRule](API_wafRegional_RateBasedRule.md). 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](API_wafRegional_UpdateWebACL.md).
To permanently delete a `RateBasedRule` from AWS WAF, perform the following steps:
1. Update the `RateBasedRule` to remove predicates, if any. For more information, see [UpdateRateBasedRule](API_wafRegional_UpdateRateBasedRule.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `DeleteRateBasedRule` request.
1. Submit a `DeleteRateBasedRule` request.
## Request Syntax
```
{
"ChangeToken": "string",
"RuleId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_DeleteRateBasedRule_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [RuleId](#API_wafRegional_DeleteRateBasedRule_RequestSyntax) **
The `RuleId` of the [RateBasedRule](API_wafRegional_RateBasedRule.md) that you want to delete. `RuleId` is returned by [CreateRateBasedRule](API_wafRegional_CreateRateBasedRule.md) and by [ListRateBasedRules](API_wafRegional_ListRateBasedRules.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_DeleteRateBasedRule_ResponseSyntax) **
The `ChangeToken` that you used to submit the `DeleteRateBasedRule` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
** WAFTagOperationException **
HTTP Status Code: 400
** WAFTagOperationInternalErrorException **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteRateBasedRule)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteRateBasedRule)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteRateBasedRule)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteRateBasedRule)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteRateBasedRule)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteRateBasedRule)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteRateBasedRule)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteRateBasedRule)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteRateBasedRule)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteRateBasedRule)
# DeleteRegexMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a [RegexMatchSet](API_wafRegional_RegexMatchSet.md). 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](API_wafRegional_UpdateRule.md).
To permanently delete a `RegexMatchSet`, perform the following steps:
1. Update the `RegexMatchSet` to remove filters, if any. For more information, see [UpdateRegexMatchSet](API_wafRegional_UpdateRegexMatchSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `DeleteRegexMatchSet` request.
1. Submit a `DeleteRegexMatchSet` request.
## Request Syntax
```
{
"ChangeToken": "string",
"RegexMatchSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_DeleteRegexMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [RegexMatchSetId](#API_wafRegional_DeleteRegexMatchSet_RequestSyntax) **
The `RegexMatchSetId` of the [RegexMatchSet](API_wafRegional_RegexMatchSet.md) that you want to delete. `RegexMatchSetId` is returned by [CreateRegexMatchSet](API_wafRegional_CreateRegexMatchSet.md) and by [ListRegexMatchSets](API_wafRegional_ListRegexMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_DeleteRegexMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `DeleteRegexMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteRegexMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteRegexMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteRegexMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteRegexMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteRegexMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteRegexMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteRegexMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteRegexMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteRegexMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteRegexMatchSet)
# DeleteRegexPatternSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a [RegexPatternSet](API_wafRegional_RegexPatternSet.md). You can't delete a `RegexPatternSet` if it's still used in any `RegexMatchSet` or if the `RegexPatternSet` is not empty.
## Request Syntax
```
{
"ChangeToken": "string",
"RegexPatternSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_DeleteRegexPatternSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [RegexPatternSetId](#API_wafRegional_DeleteRegexPatternSet_RequestSyntax) **
The `RegexPatternSetId` of the [RegexPatternSet](API_wafRegional_RegexPatternSet.md) that you want to delete. `RegexPatternSetId` is returned by [CreateRegexPatternSet](API_wafRegional_CreateRegexPatternSet.md) and by [ListRegexPatternSets](API_wafRegional_ListRegexPatternSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_DeleteRegexPatternSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `DeleteRegexPatternSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteRegexPatternSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteRegexPatternSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteRegexPatternSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteRegexPatternSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteRegexPatternSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteRegexPatternSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteRegexPatternSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteRegexPatternSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteRegexPatternSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteRegexPatternSet)
# DeleteRule
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a [Rule](API_wafRegional_Rule.md). 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](API_wafRegional_UpdateWebACL.md).
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](API_wafRegional_UpdateRule.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `DeleteRule` request.
1. Submit a `DeleteRule` request.
## Request Syntax
```
{
"ChangeToken": "string",
"RuleId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_DeleteRule_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [RuleId](#API_wafRegional_DeleteRule_RequestSyntax) **
The `RuleId` of the [Rule](API_wafRegional_Rule.md) that you want to delete. `RuleId` is returned by [CreateRule](API_wafRegional_CreateRule.md) and by [ListRules](API_wafRegional_ListRules.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_DeleteRule_ResponseSyntax) **
The `ChangeToken` that you used to submit the `DeleteRule` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
** WAFTagOperationException **
HTTP Status Code: 400
** WAFTagOperationInternalErrorException **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteRule)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteRule)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteRule)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteRule)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteRule)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteRule)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteRule)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteRule)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteRule)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteRule)
# DeleteRuleGroup
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a [RuleGroup](API_wafRegional_RuleGroup.md). You can't delete a `RuleGroup` if it's still used in any `WebACL` objects or if it still includes any rules.
If you just want to remove a `RuleGroup` from a `WebACL`, use [UpdateWebACL](API_wafRegional_UpdateWebACL.md).
To permanently delete a `RuleGroup` from AWS WAF, perform the following steps:
1. Update the `RuleGroup` to remove rules, if any. For more information, see [UpdateRuleGroup](API_wafRegional_UpdateRuleGroup.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `DeleteRuleGroup` request.
1. Submit a `DeleteRuleGroup` request.
## Request Syntax
```
{
"ChangeToken": "string",
"RuleGroupId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_DeleteRuleGroup_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [RuleGroupId](#API_wafRegional_DeleteRuleGroup_RequestSyntax) **
The `RuleGroupId` of the [RuleGroup](API_wafRegional_RuleGroup.md) that you want to delete. `RuleGroupId` is returned by [CreateRuleGroup](API_wafRegional_CreateRuleGroup.md) and by [ListRuleGroups](API_wafRegional_ListRuleGroups.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_DeleteRuleGroup_ResponseSyntax) **
The `ChangeToken` that you used to submit the `DeleteRuleGroup` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
** WAFTagOperationException **
HTTP Status Code: 400
** WAFTagOperationInternalErrorException **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteRuleGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteRuleGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteRuleGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteRuleGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteRuleGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteRuleGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteRuleGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteRuleGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteRuleGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteRuleGroup)
# DeleteSizeConstraintSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md). You can't delete a `SizeConstraintSet` if it's still used in any `Rules` or if it still includes any [SizeConstraint](API_wafRegional_SizeConstraint.md) objects (any filters).
If you just want to remove a `SizeConstraintSet` from a `Rule`, use [UpdateRule](API_wafRegional_UpdateRule.md).
To permanently delete a `SizeConstraintSet`, perform the following steps:
1. Update the `SizeConstraintSet` to remove filters, if any. For more information, see [UpdateSizeConstraintSet](API_wafRegional_UpdateSizeConstraintSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `DeleteSizeConstraintSet` request.
1. Submit a `DeleteSizeConstraintSet` request.
## Request Syntax
```
{
"ChangeToken": "string",
"SizeConstraintSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_DeleteSizeConstraintSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [SizeConstraintSetId](#API_wafRegional_DeleteSizeConstraintSet_RequestSyntax) **
The `SizeConstraintSetId` of the [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md) that you want to delete. `SizeConstraintSetId` is returned by [CreateSizeConstraintSet](API_wafRegional_CreateSizeConstraintSet.md) and by [ListSizeConstraintSets](API_wafRegional_ListSizeConstraintSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_DeleteSizeConstraintSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `DeleteSizeConstraintSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteSizeConstraintSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteSizeConstraintSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteSizeConstraintSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteSizeConstraintSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteSizeConstraintSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteSizeConstraintSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteSizeConstraintSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteSizeConstraintSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteSizeConstraintSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteSizeConstraintSet)
# DeleteSqlInjectionMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md). You can't delete a `SqlInjectionMatchSet` if it's still used in any `Rules` or if it still contains any [SqlInjectionMatchTuple](API_wafRegional_SqlInjectionMatchTuple.md) objects.
If you just want to remove a `SqlInjectionMatchSet` from a `Rule`, use [UpdateRule](API_wafRegional_UpdateRule.md).
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](API_wafRegional_UpdateSqlInjectionMatchSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `DeleteSqlInjectionMatchSet` request.
1. Submit a `DeleteSqlInjectionMatchSet` request.
## Request Syntax
```
{
"ChangeToken": "string",
"SqlInjectionMatchSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_DeleteSqlInjectionMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [SqlInjectionMatchSetId](#API_wafRegional_DeleteSqlInjectionMatchSet_RequestSyntax) **
The `SqlInjectionMatchSetId` of the [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md) that you want to delete. `SqlInjectionMatchSetId` is returned by [CreateSqlInjectionMatchSet](API_wafRegional_CreateSqlInjectionMatchSet.md) and by [ListSqlInjectionMatchSets](API_wafRegional_ListSqlInjectionMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_DeleteSqlInjectionMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `DeleteSqlInjectionMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteSqlInjectionMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteSqlInjectionMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteSqlInjectionMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteSqlInjectionMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteSqlInjectionMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteSqlInjectionMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteSqlInjectionMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteSqlInjectionMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteSqlInjectionMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteSqlInjectionMatchSet)
# DeleteWebACL
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a [WebACL](API_wafRegional_WebACL.md). You can't delete a `WebACL` if it still contains any `Rules`. Deleting a `WebACL` can't be undone.
To delete a `WebACL`, perform the following steps:
1. Update the `WebACL` to remove `Rules`, if any. For more information, see [UpdateWebACL](API_wafRegional_UpdateWebACL.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `DeleteWebACL` request.
1. Submit a `DeleteWebACL` request.
## Request Syntax
```
{
"ChangeToken": "string",
"WebACLId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_DeleteWebACL_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [WebACLId](#API_wafRegional_DeleteWebACL_RequestSyntax) **
The `WebACLId` of the [WebACL](API_wafRegional_WebACL.md) that you want to delete. `WebACLId` is returned by [CreateWebACL](API_wafRegional_CreateWebACL.md) and by [ListWebACLs](API_wafRegional_ListWebACLs.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_DeleteWebACL_ResponseSyntax) **
The `ChangeToken` that you used to submit the `DeleteWebACL` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
** WAFTagOperationException **
HTTP Status Code: 400
** WAFTagOperationInternalErrorException **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteWebACL)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteWebACL)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteWebACL)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteWebACL)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteWebACL)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteWebACL)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteWebACL)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteWebACL)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteWebACL)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteWebACL)
# DeleteXssMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes an [XssMatchSet](API_wafRegional_XssMatchSet.md). You can't delete an `XssMatchSet` if it's still used in any `Rules` or if it still contains any [XssMatchTuple](API_wafRegional_XssMatchTuple.md) objects.
If you just want to remove an `XssMatchSet` from a `Rule`, use [UpdateRule](API_wafRegional_UpdateRule.md).
To permanently delete an `XssMatchSet` from AWS WAF, perform the following steps:
1. Update the `XssMatchSet` to remove filters, if any. For more information, see [UpdateXssMatchSet](API_wafRegional_UpdateXssMatchSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of a `DeleteXssMatchSet` request.
1. Submit a `DeleteXssMatchSet` request.
## Request Syntax
```
{
"ChangeToken": "string",
"XssMatchSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_DeleteXssMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [XssMatchSetId](#API_wafRegional_DeleteXssMatchSet_RequestSyntax) **
The `XssMatchSetId` of the [XssMatchSet](API_wafRegional_XssMatchSet.md) that you want to delete. `XssMatchSetId` is returned by [CreateXssMatchSet](API_wafRegional_CreateXssMatchSet.md) and by [ListXssMatchSets](API_wafRegional_ListXssMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_DeleteXssMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `DeleteXssMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DeleteXssMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DeleteXssMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DeleteXssMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DeleteXssMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DeleteXssMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DeleteXssMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DeleteXssMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DeleteXssMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DeleteXssMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DeleteXssMatchSet)
# DisassociateWebACL
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Removes a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage.
## Request Syntax
```
{
"ResourceArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceArn](#API_wafRegional_DisassociateWebACL_RequestSyntax) **
The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed, either an application load balancer or Amazon API Gateway stage.
The ARN should be in one of the following formats:
+ For an Application Load Balancer: `arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id `
+ For an Amazon API Gateway stage: `arn:aws:apigateway:region::/restapis/api-id/stages/stage-name `
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/DisassociateWebACL)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/DisassociateWebACL)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/DisassociateWebACL)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/DisassociateWebACL)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/DisassociateWebACL)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/DisassociateWebACL)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/DisassociateWebACL)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/DisassociateWebACL)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/DisassociateWebACL)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/DisassociateWebACL)
# GetByteMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [ByteMatchSet](API_wafRegional_ByteMatchSet.md) specified by `ByteMatchSetId`.
## Request Syntax
```
{
"ByteMatchSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ByteMatchSetId](#API_wafRegional_GetByteMatchSet_RequestSyntax) **
The `ByteMatchSetId` of the [ByteMatchSet](API_wafRegional_ByteMatchSet.md) that you want to get. `ByteMatchSetId` is returned by [CreateByteMatchSet](API_wafRegional_CreateByteMatchSet.md) and by [ListByteMatchSets](API_wafRegional_ListByteMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ByteMatchSet": {
"ByteMatchSetId": "string",
"ByteMatchTuples": [
{
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"PositionalConstraint": "string",
"TargetString": blob,
"TextTransformation": "string"
}
],
"Name": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ByteMatchSet](#API_wafRegional_GetByteMatchSet_ResponseSyntax) **
Information about the [ByteMatchSet](API_wafRegional_ByteMatchSet.md) that you specified in the `GetByteMatchSet` request. For more information, see the following topics:
+ [ByteMatchSet](API_wafRegional_ByteMatchSet.md): Contains `ByteMatchSetId`, `ByteMatchTuples`, and `Name`
+ `ByteMatchTuples`: Contains an array of [ByteMatchTuple](API_wafRegional_ByteMatchTuple.md) objects. Each `ByteMatchTuple` object contains [FieldToMatch](API_wafRegional_FieldToMatch.md), `PositionalConstraint`, `TargetString`, and `TextTransformation`
+ [FieldToMatch](API_wafRegional_FieldToMatch.md): Contains `Data` and `Type`
Type: [ByteMatchSet](API_wafRegional_ByteMatchSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetByteMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetByteMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetByteMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetByteMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetByteMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetByteMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetByteMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetByteMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetByteMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetByteMatchSet)
# GetChangeToken
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
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.
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_GetChangeToken_ResponseSyntax) **
The `ChangeToken` that you used in the request. Use this value in a `GetChangeTokenStatus` request to get the current status of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetChangeToken)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetChangeToken)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetChangeToken)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetChangeToken)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetChangeToken)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetChangeToken)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetChangeToken)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetChangeToken)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetChangeToken)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetChangeToken)
# GetChangeTokenStatus
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the status of a `ChangeToken` that you got by calling [GetChangeToken](API_wafRegional_GetChangeToken.md). `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.
+ `INSYNC`: Propagation is complete.
## Request Syntax
```
{
"ChangeToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_GetChangeTokenStatus_RequestSyntax) **
The change token for which you want to get the status. This change token was previously returned in the `GetChangeToken` response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeTokenStatus": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeTokenStatus](#API_wafRegional_GetChangeTokenStatus_ResponseSyntax) **
The status of the change token.
Type: String
Valid Values: `PROVISIONED | PENDING | INSYNC`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetChangeTokenStatus)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetChangeTokenStatus)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetChangeTokenStatus)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetChangeTokenStatus)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetChangeTokenStatus)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetChangeTokenStatus)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetChangeTokenStatus)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetChangeTokenStatus)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetChangeTokenStatus)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetChangeTokenStatus)
# GetGeoMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [GeoMatchSet](API_wafRegional_GeoMatchSet.md) that is specified by `GeoMatchSetId`.
## Request Syntax
```
{
"GeoMatchSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [GeoMatchSetId](#API_wafRegional_GetGeoMatchSet_RequestSyntax) **
The `GeoMatchSetId` of the [GeoMatchSet](API_wafRegional_GeoMatchSet.md) that you want to get. `GeoMatchSetId` is returned by [CreateGeoMatchSet](API_wafRegional_CreateGeoMatchSet.md) and by [ListGeoMatchSets](API_wafRegional_ListGeoMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"GeoMatchSet": {
"GeoMatchConstraints": [
{
"Type": "string",
"Value": "string"
}
],
"GeoMatchSetId": "string",
"Name": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GeoMatchSet](#API_wafRegional_GetGeoMatchSet_ResponseSyntax) **
Information about the [GeoMatchSet](API_wafRegional_GeoMatchSet.md) that you specified in the `GetGeoMatchSet` request. This includes the `Type`, which for a `GeoMatchConstraint` is always `Country`, as well as the `Value`, which is the identifier for a specific country.
Type: [GeoMatchSet](API_wafRegional_GeoMatchSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetGeoMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetGeoMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetGeoMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetGeoMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetGeoMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetGeoMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetGeoMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetGeoMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetGeoMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetGeoMatchSet)
# GetIPSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [IPSet](API_wafRegional_IPSet.md) that is specified by `IPSetId`.
## Request Syntax
```
{
"IPSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [IPSetId](#API_wafRegional_GetIPSet_RequestSyntax) **
The `IPSetId` of the [IPSet](API_wafRegional_IPSet.md) that you want to get. `IPSetId` is returned by [CreateIPSet](API_wafRegional_CreateIPSet.md) and by [ListIPSets](API_wafRegional_ListIPSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"IPSet": {
"IPSetDescriptors": [
{
"Type": "string",
"Value": "string"
}
],
"IPSetId": "string",
"Name": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [IPSet](#API_wafRegional_GetIPSet_ResponseSyntax) **
Information about the [IPSet](API_wafRegional_IPSet.md) that you specified in the `GetIPSet` request. For more information, see the following topics:
+ [IPSet](API_wafRegional_IPSet.md): Contains `IPSetDescriptors`, `IPSetId`, and `Name`
+ `IPSetDescriptors`: Contains an array of [IPSetDescriptor](API_wafRegional_IPSetDescriptor.md) objects. Each `IPSetDescriptor` object contains `Type` and `Value`
Type: [IPSet](API_wafRegional_IPSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetIPSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetIPSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetIPSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetIPSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetIPSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetIPSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetIPSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetIPSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetIPSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetIPSet)
# GetLoggingConfiguration
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md) for the specified web ACL.
## Request Syntax
```
{
"ResourceArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceArn](#API_wafRegional_GetLoggingConfiguration_RequestSyntax) **
The Amazon Resource Name (ARN) of the web ACL for which you want to get the [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"LoggingConfiguration": {
"LogDestinationConfigs": [ "string" ],
"RedactedFields": [
{
"Data": "string",
"Type": "string"
}
],
"ResourceArn": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [LoggingConfiguration](#API_wafRegional_GetLoggingConfiguration_ResponseSyntax) **
The [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md) for the specified web ACL.
Type: [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetLoggingConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetLoggingConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetLoggingConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetLoggingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetLoggingConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetLoggingConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetLoggingConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetLoggingConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetLoggingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetLoggingConfiguration)
# GetPermissionPolicy
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the IAM policy attached to the RuleGroup.
## Request Syntax
```
{
"ResourceArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceArn](#API_wafRegional_GetPermissionPolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"Policy": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Policy](#API_wafRegional_GetPermissionPolicy_ResponseSyntax) **
The IAM policy attached to the specified RuleGroup.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 395000.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetPermissionPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetPermissionPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetPermissionPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetPermissionPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetPermissionPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetPermissionPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetPermissionPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetPermissionPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetPermissionPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetPermissionPolicy)
# GetRateBasedRule
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [RateBasedRule](API_wafRegional_RateBasedRule.md) that is specified by the `RuleId` that you included in the `GetRateBasedRule` request.
## Request Syntax
```
{
"RuleId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [RuleId](#API_wafRegional_GetRateBasedRule_RequestSyntax) **
The `RuleId` of the [RateBasedRule](API_wafRegional_RateBasedRule.md) that you want to get. `RuleId` is returned by [CreateRateBasedRule](API_wafRegional_CreateRateBasedRule.md) and by [ListRateBasedRules](API_wafRegional_ListRateBasedRules.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"Rule": {
"MatchPredicates": [
{
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
],
"MetricName": "string",
"Name": "string",
"RateKey": "string",
"RateLimit": number,
"RuleId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Rule](#API_wafRegional_GetRateBasedRule_ResponseSyntax) **
Information about the [RateBasedRule](API_wafRegional_RateBasedRule.md) that you specified in the `GetRateBasedRule` request.
Type: [RateBasedRule](API_wafRegional_RateBasedRule.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetRateBasedRule)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetRateBasedRule)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetRateBasedRule)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetRateBasedRule)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetRateBasedRule)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetRateBasedRule)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetRateBasedRule)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetRateBasedRule)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetRateBasedRule)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetRateBasedRule)
# GetRateBasedRuleManagedKeys
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of IP addresses currently being blocked by the [RateBasedRule](API_wafRegional_RateBasedRule.md) 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.
## Request Syntax
```
{
"NextMarker": "string",
"RuleId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [NextMarker](#API_wafRegional_GetRateBasedRuleManagedKeys_RequestSyntax) **
A null value and not currently used. Do not include this in your request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
** [RuleId](#API_wafRegional_GetRateBasedRuleManagedKeys_RequestSyntax) **
The `RuleId` of the [RateBasedRule](API_wafRegional_RateBasedRule.md) for which you want to get a list of `ManagedKeys`. `RuleId` is returned by [CreateRateBasedRule](API_wafRegional_CreateRateBasedRule.md) and by [ListRateBasedRules](API_wafRegional_ListRateBasedRules.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ManagedKeys": [ "string" ],
"NextMarker": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ManagedKeys](#API_wafRegional_GetRateBasedRuleManagedKeys_ResponseSyntax) **
An array of IP addresses that currently are blocked by the specified [RateBasedRule](API_wafRegional_RateBasedRule.md).
Type: Array of strings
** [NextMarker](#API_wafRegional_GetRateBasedRuleManagedKeys_ResponseSyntax) **
A null value and not currently used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetRateBasedRuleManagedKeys)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetRateBasedRuleManagedKeys)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetRateBasedRuleManagedKeys)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetRateBasedRuleManagedKeys)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetRateBasedRuleManagedKeys)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetRateBasedRuleManagedKeys)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetRateBasedRuleManagedKeys)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetRateBasedRuleManagedKeys)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetRateBasedRuleManagedKeys)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetRateBasedRuleManagedKeys)
# GetRegexMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [RegexMatchSet](API_wafRegional_RegexMatchSet.md) specified by `RegexMatchSetId`.
## Request Syntax
```
{
"RegexMatchSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [RegexMatchSetId](#API_wafRegional_GetRegexMatchSet_RequestSyntax) **
The `RegexMatchSetId` of the [RegexMatchSet](API_wafRegional_RegexMatchSet.md) that you want to get. `RegexMatchSetId` is returned by [CreateRegexMatchSet](API_wafRegional_CreateRegexMatchSet.md) and by [ListRegexMatchSets](API_wafRegional_ListRegexMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"RegexMatchSet": {
"Name": "string",
"RegexMatchSetId": "string",
"RegexMatchTuples": [
{
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"RegexPatternSetId": "string",
"TextTransformation": "string"
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [RegexMatchSet](#API_wafRegional_GetRegexMatchSet_ResponseSyntax) **
Information about the [RegexMatchSet](API_wafRegional_RegexMatchSet.md) that you specified in the `GetRegexMatchSet` request. For more information, see [RegexMatchTuple](API_wafRegional_RegexMatchTuple.md).
Type: [RegexMatchSet](API_wafRegional_RegexMatchSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetRegexMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetRegexMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetRegexMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetRegexMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetRegexMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetRegexMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetRegexMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetRegexMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetRegexMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetRegexMatchSet)
# GetRegexPatternSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [RegexPatternSet](API_wafRegional_RegexPatternSet.md) specified by `RegexPatternSetId`.
## Request Syntax
```
{
"RegexPatternSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [RegexPatternSetId](#API_wafRegional_GetRegexPatternSet_RequestSyntax) **
The `RegexPatternSetId` of the [RegexPatternSet](API_wafRegional_RegexPatternSet.md) that you want to get. `RegexPatternSetId` is returned by [CreateRegexPatternSet](API_wafRegional_CreateRegexPatternSet.md) and by [ListRegexPatternSets](API_wafRegional_ListRegexPatternSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"RegexPatternSet": {
"Name": "string",
"RegexPatternSetId": "string",
"RegexPatternStrings": [ "string" ]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [RegexPatternSet](#API_wafRegional_GetRegexPatternSet_ResponseSyntax) **
Information about the [RegexPatternSet](API_wafRegional_RegexPatternSet.md) that you specified in the `GetRegexPatternSet` request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for.
Type: [RegexPatternSet](API_wafRegional_RegexPatternSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetRegexPatternSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetRegexPatternSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetRegexPatternSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetRegexPatternSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetRegexPatternSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetRegexPatternSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetRegexPatternSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetRegexPatternSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetRegexPatternSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetRegexPatternSet)
# GetRule
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [Rule](API_wafRegional_Rule.md) that is specified by the `RuleId` that you included in the `GetRule` request.
## Request Syntax
```
{
"RuleId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [RuleId](#API_wafRegional_GetRule_RequestSyntax) **
The `RuleId` of the [Rule](API_wafRegional_Rule.md) that you want to get. `RuleId` is returned by [CreateRule](API_wafRegional_CreateRule.md) and by [ListRules](API_wafRegional_ListRules.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"Rule": {
"MetricName": "string",
"Name": "string",
"Predicates": [
{
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
],
"RuleId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Rule](#API_wafRegional_GetRule_ResponseSyntax) **
Information about the [Rule](API_wafRegional_Rule.md) that you specified in the `GetRule` request. For more information, see the following topics:
+ [Rule](API_wafRegional_Rule.md): Contains `MetricName`, `Name`, an array of `Predicate` objects, and `RuleId`
+ [Predicate](API_wafRegional_Predicate.md): Each `Predicate` object contains `DataId`, `Negated`, and `Type`
Type: [Rule](API_wafRegional_Rule.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetRule)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetRule)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetRule)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetRule)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetRule)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetRule)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetRule)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetRule)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetRule)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetRule)
# GetRuleGroup
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [RuleGroup](API_wafRegional_RuleGroup.md) that is specified by the `RuleGroupId` that you included in the `GetRuleGroup` request.
To view the rules in a rule group, use [ListActivatedRulesInRuleGroup](API_wafRegional_ListActivatedRulesInRuleGroup.md).
## Request Syntax
```
{
"RuleGroupId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [RuleGroupId](#API_wafRegional_GetRuleGroup_RequestSyntax) **
The `RuleGroupId` of the [RuleGroup](API_wafRegional_RuleGroup.md) that you want to get. `RuleGroupId` is returned by [CreateRuleGroup](API_wafRegional_CreateRuleGroup.md) and by [ListRuleGroups](API_wafRegional_ListRuleGroups.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"RuleGroup": {
"MetricName": "string",
"Name": "string",
"RuleGroupId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [RuleGroup](#API_wafRegional_GetRuleGroup_ResponseSyntax) **
Information about the [RuleGroup](API_wafRegional_RuleGroup.md) that you specified in the `GetRuleGroup` request.
Type: [RuleGroup](API_wafRegional_RuleGroup.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetRuleGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetRuleGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetRuleGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetRuleGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetRuleGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetRuleGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetRuleGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetRuleGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetRuleGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetRuleGroup)
# GetSampledRequests
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
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 an Amazon 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.
## Request Syntax
```
{
"MaxItems": number,
"RuleId": "string",
"TimeWindow": {
"EndTime": number,
"StartTime": number
},
"WebAclId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [MaxItems](#API_wafRegional_GetSampledRequests_RequestSyntax) **
The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of `MaxItems`, `GetSampledRequests` returns information about all of them.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 500.
Required: Yes
** [RuleId](#API_wafRegional_GetSampledRequests_RequestSyntax) **
`RuleId` is one of three values:
+ The `RuleId` of the `Rule` or the `RuleGroupId` of the `RuleGroup` for which you want `GetSampledRequests` to return a sample of requests.
+ `Default_Action`, which causes `GetSampledRequests` to return a sample of the requests that didn't match any of the rules in the specified `WebACL`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [TimeWindow](#API_wafRegional_GetSampledRequests_RequestSyntax) **
The start date and time and the end date and time of the range for which you want `GetSampledRequests` to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, `Z`. For example, `"2016-09-27T14:50Z"`. You can specify any time range in the previous three hours.
Type: [TimeWindow](API_wafRegional_TimeWindow.md) object
Required: Yes
** [WebAclId](#API_wafRegional_GetSampledRequests_RequestSyntax) **
The `WebACLId` of the `WebACL` for which you want `GetSampledRequests` to return a sample of requests.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"PopulationSize": number,
"SampledRequests": [
{
"Action": "string",
"Request": {
"ClientIP": "string",
"Country": "string",
"Headers": [
{
"Name": "string",
"Value": "string"
}
],
"HTTPVersion": "string",
"Method": "string",
"URI": "string"
},
"RuleWithinRuleGroup": "string",
"Timestamp": number,
"Weight": number
}
],
"TimeWindow": {
"EndTime": number,
"StartTime": number
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [PopulationSize](#API_wafRegional_GetSampledRequests_ResponseSyntax) **
The total number of requests from which `GetSampledRequests` got a sample of `MaxItems` requests. If `PopulationSize` is less than `MaxItems`, the sample includes every request that your AWS resource received during the specified time range.
Type: Long
** [SampledRequests](#API_wafRegional_GetSampledRequests_ResponseSyntax) **
A complex type that contains detailed information about each of the requests in the sample.
Type: Array of [SampledHTTPRequest](API_wafRegional_SampledHTTPRequest.md) objects
** [TimeWindow](#API_wafRegional_GetSampledRequests_ResponseSyntax) **
Usually, `TimeWindow` is the time range that you specified in the `GetSampledRequests` request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, `GetSampledRequests` returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.
Type: [TimeWindow](API_wafRegional_TimeWindow.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetSampledRequests)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetSampledRequests)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetSampledRequests)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetSampledRequests)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetSampledRequests)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetSampledRequests)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetSampledRequests)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetSampledRequests)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetSampledRequests)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetSampledRequests)
# GetSizeConstraintSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md) specified by `SizeConstraintSetId`.
## Request Syntax
```
{
"SizeConstraintSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [SizeConstraintSetId](#API_wafRegional_GetSizeConstraintSet_RequestSyntax) **
The `SizeConstraintSetId` of the [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md) that you want to get. `SizeConstraintSetId` is returned by [CreateSizeConstraintSet](API_wafRegional_CreateSizeConstraintSet.md) and by [ListSizeConstraintSets](API_wafRegional_ListSizeConstraintSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"SizeConstraintSet": {
"Name": "string",
"SizeConstraints": [
{
"ComparisonOperator": "string",
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"Size": number,
"TextTransformation": "string"
}
],
"SizeConstraintSetId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [SizeConstraintSet](#API_wafRegional_GetSizeConstraintSet_ResponseSyntax) **
Information about the [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md) that you specified in the `GetSizeConstraintSet` request. For more information, see the following topics:
+ [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md): Contains `SizeConstraintSetId`, `SizeConstraints`, and `Name`
+ `SizeConstraints`: Contains an array of [SizeConstraint](API_wafRegional_SizeConstraint.md) objects. Each `SizeConstraint` object contains [FieldToMatch](API_wafRegional_FieldToMatch.md), `TextTransformation`, `ComparisonOperator`, and `Size`
+ [FieldToMatch](API_wafRegional_FieldToMatch.md): Contains `Data` and `Type`
Type: [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetSizeConstraintSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetSizeConstraintSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetSizeConstraintSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetSizeConstraintSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetSizeConstraintSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetSizeConstraintSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetSizeConstraintSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetSizeConstraintSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetSizeConstraintSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetSizeConstraintSet)
# GetSqlInjectionMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md) that is specified by `SqlInjectionMatchSetId`.
## Request Syntax
```
{
"SqlInjectionMatchSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [SqlInjectionMatchSetId](#API_wafRegional_GetSqlInjectionMatchSet_RequestSyntax) **
The `SqlInjectionMatchSetId` of the [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md) that you want to get. `SqlInjectionMatchSetId` is returned by [CreateSqlInjectionMatchSet](API_wafRegional_CreateSqlInjectionMatchSet.md) and by [ListSqlInjectionMatchSets](API_wafRegional_ListSqlInjectionMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"SqlInjectionMatchSet": {
"Name": "string",
"SqlInjectionMatchSetId": "string",
"SqlInjectionMatchTuples": [
{
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"TextTransformation": "string"
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [SqlInjectionMatchSet](#API_wafRegional_GetSqlInjectionMatchSet_ResponseSyntax) **
Information about the [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md) that you specified in the `GetSqlInjectionMatchSet` request. For more information, see the following topics:
+ [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md): Contains `Name`, `SqlInjectionMatchSetId`, and an array of `SqlInjectionMatchTuple` objects
+ [SqlInjectionMatchTuple](API_wafRegional_SqlInjectionMatchTuple.md): Each `SqlInjectionMatchTuple` object contains `FieldToMatch` and `TextTransformation`
+ [FieldToMatch](API_wafRegional_FieldToMatch.md): Contains `Data` and `Type`
Type: [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetSqlInjectionMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetSqlInjectionMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetSqlInjectionMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetSqlInjectionMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetSqlInjectionMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetSqlInjectionMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetSqlInjectionMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetSqlInjectionMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetSqlInjectionMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetSqlInjectionMatchSet)
# GetWebACL
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [WebACL](API_wafRegional_WebACL.md) that is specified by `WebACLId`.
## Request Syntax
```
{
"WebACLId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [WebACLId](#API_wafRegional_GetWebACL_RequestSyntax) **
The `WebACLId` of the [WebACL](API_wafRegional_WebACL.md) that you want to get. `WebACLId` is returned by [CreateWebACL](API_wafRegional_CreateWebACL.md) and by [ListWebACLs](API_wafRegional_ListWebACLs.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"WebACL": {
"DefaultAction": {
"Type": "string"
},
"MetricName": "string",
"Name": "string",
"Rules": [
{
"Action": {
"Type": "string"
},
"ExcludedRules": [
{
"RuleId": "string"
}
],
"OverrideAction": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
],
"WebACLArn": "string",
"WebACLId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [WebACL](#API_wafRegional_GetWebACL_ResponseSyntax) **
Information about the [WebACL](API_wafRegional_WebACL.md) that you specified in the `GetWebACL` request. For more information, see the following topics:
+ [WebACL](API_wafRegional_WebACL.md): Contains `DefaultAction`, `MetricName`, `Name`, an array of `Rule` objects, and `WebACLId`
+ `DefaultAction` (Data type is [WafAction](API_wafRegional_WafAction.md)): Contains `Type`
+ `Rules`: Contains an array of `ActivatedRule` objects, which contain `Action`, `Priority`, and `RuleId`
+ `Action`: Contains `Type`
Type: [WebACL](API_wafRegional_WebACL.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetWebACL)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetWebACL)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetWebACL)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetWebACL)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetWebACL)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetWebACL)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetWebACL)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetWebACL)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetWebACL)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetWebACL)
# GetWebACLForResource
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage.
## Request Syntax
```
{
"ResourceArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceArn](#API_wafRegional_GetWebACLForResource_RequestSyntax) **
The ARN (Amazon Resource Name) of the resource for which to get the web ACL, either an application load balancer or Amazon API Gateway stage.
The ARN should be in one of the following formats:
+ For an Application Load Balancer: `arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id `
+ For an Amazon API Gateway stage: `arn:aws:apigateway:region::/restapis/api-id/stages/stage-name `
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"WebACLSummary": {
"Name": "string",
"WebACLId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [WebACLSummary](#API_wafRegional_GetWebACLForResource_ResponseSyntax) **
Information about the web ACL that you specified in the `GetWebACLForResource` request. If there is no associated resource, a null WebACLSummary is returned.
Type: [WebACLSummary](API_wafRegional_WebACLSummary.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFUnavailableEntityException **
The operation failed because the entity referenced is temporarily unavailable. Retry your request.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetWebACLForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetWebACLForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetWebACLForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetWebACLForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetWebACLForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetWebACLForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetWebACLForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetWebACLForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetWebACLForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetWebACLForResource)
# GetXssMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the [XssMatchSet](API_wafRegional_XssMatchSet.md) that is specified by `XssMatchSetId`.
## Request Syntax
```
{
"XssMatchSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [XssMatchSetId](#API_wafRegional_GetXssMatchSet_RequestSyntax) **
The `XssMatchSetId` of the [XssMatchSet](API_wafRegional_XssMatchSet.md) that you want to get. `XssMatchSetId` is returned by [CreateXssMatchSet](API_wafRegional_CreateXssMatchSet.md) and by [ListXssMatchSets](API_wafRegional_ListXssMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"XssMatchSet": {
"Name": "string",
"XssMatchSetId": "string",
"XssMatchTuples": [
{
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"TextTransformation": "string"
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [XssMatchSet](#API_wafRegional_GetXssMatchSet_ResponseSyntax) **
Information about the [XssMatchSet](API_wafRegional_XssMatchSet.md) that you specified in the `GetXssMatchSet` request. For more information, see the following topics:
+ [XssMatchSet](API_wafRegional_XssMatchSet.md): Contains `Name`, `XssMatchSetId`, and an array of `XssMatchTuple` objects
+ [XssMatchTuple](API_wafRegional_XssMatchTuple.md): Each `XssMatchTuple` object contains `FieldToMatch` and `TextTransformation`
+ [FieldToMatch](API_wafRegional_FieldToMatch.md): Contains `Data` and `Type`
Type: [XssMatchSet](API_wafRegional_XssMatchSet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/GetXssMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/GetXssMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/GetXssMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/GetXssMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/GetXssMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/GetXssMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/GetXssMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/GetXssMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/GetXssMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/GetXssMatchSet)
# ListActivatedRulesInRuleGroup
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [ActivatedRule](API_wafRegional_ActivatedRule.md) objects.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string",
"RuleGroupId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListActivatedRulesInRuleGroup_RequestSyntax) **
Specifies the number of `ActivatedRules` that you want AWS WAF to return for this request. If you have more `ActivatedRules` than the number that you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `ActivatedRules`.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListActivatedRulesInRuleGroup_RequestSyntax) **
If you specify a value for `Limit` and you have more `ActivatedRules` than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `ActivatedRules`. For the second and subsequent `ListActivatedRulesInRuleGroup` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `ActivatedRules`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
** [RuleGroupId](#API_wafRegional_ListActivatedRulesInRuleGroup_RequestSyntax) **
The `RuleGroupId` of the [RuleGroup](API_wafRegional_RuleGroup.md) for which you want to get a list of [ActivatedRule](API_wafRegional_ActivatedRule.md) objects.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"ActivatedRules": [
{
"Action": {
"Type": "string"
},
"ExcludedRules": [
{
"RuleId": "string"
}
],
"OverrideAction": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
],
"NextMarker": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ActivatedRules](#API_wafRegional_ListActivatedRulesInRuleGroup_ResponseSyntax) **
An array of `ActivatedRules` objects.
Type: Array of [ActivatedRule](API_wafRegional_ActivatedRule.md) objects
** [NextMarker](#API_wafRegional_ListActivatedRulesInRuleGroup_ResponseSyntax) **
If you have more `ActivatedRules` than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `ActivatedRules`, submit another `ListActivatedRulesInRuleGroup` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** 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\$1STRING, 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListActivatedRulesInRuleGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListActivatedRulesInRuleGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListActivatedRulesInRuleGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListActivatedRulesInRuleGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListActivatedRulesInRuleGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListActivatedRulesInRuleGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListActivatedRulesInRuleGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListActivatedRulesInRuleGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListActivatedRulesInRuleGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListActivatedRulesInRuleGroup)
# ListByteMatchSets
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [ByteMatchSetSummary](API_wafRegional_ByteMatchSetSummary.md) objects.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListByteMatchSets_RequestSyntax) **
Specifies the number of `ByteMatchSet` objects that you want AWS WAF to return for this request. If you have more `ByteMatchSets` objects than the number you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `ByteMatchSet` objects.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListByteMatchSets_RequestSyntax) **
If you specify a value for `Limit` and you have more `ByteMatchSets` than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `ByteMatchSets`. For the second and subsequent `ListByteMatchSets` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `ByteMatchSets`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"ByteMatchSets": [
{
"ByteMatchSetId": "string",
"Name": "string"
}
],
"NextMarker": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ByteMatchSets](#API_wafRegional_ListByteMatchSets_ResponseSyntax) **
An array of [ByteMatchSetSummary](API_wafRegional_ByteMatchSetSummary.md) objects.
Type: Array of [ByteMatchSetSummary](API_wafRegional_ByteMatchSetSummary.md) objects
** [NextMarker](#API_wafRegional_ListByteMatchSets_ResponseSyntax) **
If you have more `ByteMatchSet` objects than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `ByteMatchSet` objects, submit another `ListByteMatchSets` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListByteMatchSets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListByteMatchSets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListByteMatchSets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListByteMatchSets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListByteMatchSets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListByteMatchSets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListByteMatchSets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListByteMatchSets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListByteMatchSets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListByteMatchSets)
# ListGeoMatchSets
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [GeoMatchSetSummary](API_wafRegional_GeoMatchSetSummary.md) objects in the response.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListGeoMatchSets_RequestSyntax) **
Specifies the number of `GeoMatchSet` objects that you want AWS WAF to return for this request. If you have more `GeoMatchSet` objects than the number you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `GeoMatchSet` objects.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListGeoMatchSets_RequestSyntax) **
If you specify a value for `Limit` and you have more `GeoMatchSet`s than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `GeoMatchSet` objects. For the second and subsequent `ListGeoMatchSets` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `GeoMatchSet` objects.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"GeoMatchSets": [
{
"GeoMatchSetId": "string",
"Name": "string"
}
],
"NextMarker": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GeoMatchSets](#API_wafRegional_ListGeoMatchSets_ResponseSyntax) **
An array of [GeoMatchSetSummary](API_wafRegional_GeoMatchSetSummary.md) objects.
Type: Array of [GeoMatchSetSummary](API_wafRegional_GeoMatchSetSummary.md) objects
** [NextMarker](#API_wafRegional_ListGeoMatchSets_ResponseSyntax) **
If you have more `GeoMatchSet` objects than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `GeoMatchSet` objects, submit another `ListGeoMatchSets` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListGeoMatchSets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListGeoMatchSets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListGeoMatchSets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListGeoMatchSets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListGeoMatchSets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListGeoMatchSets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListGeoMatchSets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListGeoMatchSets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListGeoMatchSets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListGeoMatchSets)
# ListIPSets
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [IPSetSummary](API_wafRegional_IPSetSummary.md) objects in the response.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListIPSets_RequestSyntax) **
Specifies the number of `IPSet` objects that you want AWS WAF to return for this request. If you have more `IPSet` objects than the number you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `IPSet` objects.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListIPSets_RequestSyntax) **
AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `IPSets`. For the second and subsequent `ListIPSets` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `IPSets`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"IPSets": [
{
"IPSetId": "string",
"Name": "string"
}
],
"NextMarker": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [IPSets](#API_wafRegional_ListIPSets_ResponseSyntax) **
An array of [IPSetSummary](API_wafRegional_IPSetSummary.md) objects.
Type: Array of [IPSetSummary](API_wafRegional_IPSetSummary.md) objects
** [NextMarker](#API_wafRegional_ListIPSets_ResponseSyntax) **
To list more `IPSet` objects, submit another `ListIPSets` request, and in the next request use the `NextMarker` response value as the `NextMarker` value.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListIPSets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListIPSets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListIPSets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListIPSets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListIPSets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListIPSets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListIPSets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListIPSets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListIPSets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListIPSets)
# ListLoggingConfigurations
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md) objects.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListLoggingConfigurations_RequestSyntax) **
Specifies the number of `LoggingConfigurations` that you want AWS WAF to return for this request. If you have more `LoggingConfigurations` than the number that you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `LoggingConfigurations`.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListLoggingConfigurations_RequestSyntax) **
If you specify a value for `Limit` and you have more `LoggingConfigurations` than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `LoggingConfigurations`. For the second and subsequent `ListLoggingConfigurations` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `ListLoggingConfigurations`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"LoggingConfigurations": [
{
"LogDestinationConfigs": [ "string" ],
"RedactedFields": [
{
"Data": "string",
"Type": "string"
}
],
"ResourceArn": "string"
}
],
"NextMarker": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [LoggingConfigurations](#API_wafRegional_ListLoggingConfigurations_ResponseSyntax) **
An array of [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md) objects.
Type: Array of [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md) objects
** [NextMarker](#API_wafRegional_ListLoggingConfigurations_ResponseSyntax) **
If you have more `LoggingConfigurations` than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `LoggingConfigurations`, submit another `ListLoggingConfigurations` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** 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\$1STRING, 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListLoggingConfigurations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListLoggingConfigurations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListLoggingConfigurations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListLoggingConfigurations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListLoggingConfigurations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListLoggingConfigurations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListLoggingConfigurations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListLoggingConfigurations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListLoggingConfigurations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListLoggingConfigurations)
# ListRateBasedRules
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [RuleSummary](API_wafRegional_RuleSummary.md) objects.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListRateBasedRules_RequestSyntax) **
Specifies the number of `Rules` that you want AWS WAF to return for this request. If you have more `Rules` than the number that you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `Rules`.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListRateBasedRules_RequestSyntax) **
If you specify a value for `Limit` and you have more `Rules` than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `Rules`. For the second and subsequent `ListRateBasedRules` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `Rules`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"NextMarker": "string",
"Rules": [
{
"Name": "string",
"RuleId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextMarker](#API_wafRegional_ListRateBasedRules_ResponseSyntax) **
If you have more `Rules` than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `Rules`, submit another `ListRateBasedRules` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
** [Rules](#API_wafRegional_ListRateBasedRules_ResponseSyntax) **
An array of [RuleSummary](API_wafRegional_RuleSummary.md) objects.
Type: Array of [RuleSummary](API_wafRegional_RuleSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListRateBasedRules)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListRateBasedRules)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListRateBasedRules)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListRateBasedRules)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListRateBasedRules)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListRateBasedRules)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListRateBasedRules)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListRateBasedRules)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListRateBasedRules)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListRateBasedRules)
# ListRegexMatchSets
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [RegexMatchSetSummary](API_wafRegional_RegexMatchSetSummary.md) objects.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListRegexMatchSets_RequestSyntax) **
Specifies the number of `RegexMatchSet` objects that you want AWS WAF to return for this request. If you have more `RegexMatchSet` objects than the number you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `RegexMatchSet` objects.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListRegexMatchSets_RequestSyntax) **
If you specify a value for `Limit` and you have more `RegexMatchSet` objects than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `ByteMatchSets`. For the second and subsequent `ListRegexMatchSets` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `RegexMatchSet` objects.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"NextMarker": "string",
"RegexMatchSets": [
{
"Name": "string",
"RegexMatchSetId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextMarker](#API_wafRegional_ListRegexMatchSets_ResponseSyntax) **
If you have more `RegexMatchSet` objects than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `RegexMatchSet` objects, submit another `ListRegexMatchSets` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
** [RegexMatchSets](#API_wafRegional_ListRegexMatchSets_ResponseSyntax) **
An array of [RegexMatchSetSummary](API_wafRegional_RegexMatchSetSummary.md) objects.
Type: Array of [RegexMatchSetSummary](API_wafRegional_RegexMatchSetSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListRegexMatchSets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListRegexMatchSets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListRegexMatchSets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListRegexMatchSets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListRegexMatchSets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListRegexMatchSets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListRegexMatchSets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListRegexMatchSets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListRegexMatchSets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListRegexMatchSets)
# ListRegexPatternSets
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [RegexPatternSetSummary](API_wafRegional_RegexPatternSetSummary.md) objects.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListRegexPatternSets_RequestSyntax) **
Specifies the number of `RegexPatternSet` objects that you want AWS WAF to return for this request. If you have more `RegexPatternSet` objects than the number you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `RegexPatternSet` objects.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListRegexPatternSets_RequestSyntax) **
If you specify a value for `Limit` and you have more `RegexPatternSet` objects than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `RegexPatternSet` objects. For the second and subsequent `ListRegexPatternSets` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `RegexPatternSet` objects.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"NextMarker": "string",
"RegexPatternSets": [
{
"Name": "string",
"RegexPatternSetId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextMarker](#API_wafRegional_ListRegexPatternSets_ResponseSyntax) **
If you have more `RegexPatternSet` objects than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `RegexPatternSet` objects, submit another `ListRegexPatternSets` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
** [RegexPatternSets](#API_wafRegional_ListRegexPatternSets_ResponseSyntax) **
An array of [RegexPatternSetSummary](API_wafRegional_RegexPatternSetSummary.md) objects.
Type: Array of [RegexPatternSetSummary](API_wafRegional_RegexPatternSetSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListRegexPatternSets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListRegexPatternSets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListRegexPatternSets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListRegexPatternSets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListRegexPatternSets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListRegexPatternSets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListRegexPatternSets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListRegexPatternSets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListRegexPatternSets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListRegexPatternSets)
# ListResourcesForWebACL
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of resources associated with the specified web ACL.
## Request Syntax
```
{
"ResourceType": "string",
"WebACLId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceType](#API_wafRegional_ListResourcesForWebACL_RequestSyntax) **
The type of resource to list.
Type: String
Valid Values: `APPLICATION_LOAD_BALANCER | API_GATEWAY`
Required: No
** [WebACLId](#API_wafRegional_ListResourcesForWebACL_RequestSyntax) **
The unique identifier (ID) of the web ACL for which to list the associated resources.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ResourceArns": [ "string" ]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ResourceArns](#API_wafRegional_ListResourcesForWebACL_ResponseSyntax) **
An array of ARNs (Amazon Resource Names) of the resources associated with the specified web ACL. An array with zero elements is returned if there are no resources associated with the web ACL.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListResourcesForWebACL)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListResourcesForWebACL)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListResourcesForWebACL)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListResourcesForWebACL)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListResourcesForWebACL)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListResourcesForWebACL)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListResourcesForWebACL)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListResourcesForWebACL)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListResourcesForWebACL)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListResourcesForWebACL)
# ListRuleGroups
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [RuleGroup](API_wafRegional_RuleGroup.md) objects.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListRuleGroups_RequestSyntax) **
Specifies the number of `RuleGroups` that you want AWS WAF to return for this request. If you have more `RuleGroups` than the number that you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `RuleGroups`.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListRuleGroups_RequestSyntax) **
If you specify a value for `Limit` and you have more `RuleGroups` than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `RuleGroups`. For the second and subsequent `ListRuleGroups` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `RuleGroups`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"NextMarker": "string",
"RuleGroups": [
{
"Name": "string",
"RuleGroupId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextMarker](#API_wafRegional_ListRuleGroups_ResponseSyntax) **
If you have more `RuleGroups` than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `RuleGroups`, submit another `ListRuleGroups` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
** [RuleGroups](#API_wafRegional_ListRuleGroups_ResponseSyntax) **
An array of [RuleGroup](API_wafRegional_RuleGroup.md) objects.
Type: Array of [RuleGroupSummary](API_wafRegional_RuleGroupSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListRuleGroups)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListRuleGroups)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListRuleGroups)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListRuleGroups)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListRuleGroups)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListRuleGroups)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListRuleGroups)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListRuleGroups)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListRuleGroups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListRuleGroups)
# ListRules
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [RuleSummary](API_wafRegional_RuleSummary.md) objects.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListRules_RequestSyntax) **
Specifies the number of `Rules` that you want AWS WAF to return for this request. If you have more `Rules` than the number that you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `Rules`.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListRules_RequestSyntax) **
If you specify a value for `Limit` and you have more `Rules` than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `Rules`. For the second and subsequent `ListRules` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `Rules`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"NextMarker": "string",
"Rules": [
{
"Name": "string",
"RuleId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextMarker](#API_wafRegional_ListRules_ResponseSyntax) **
If you have more `Rules` than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `Rules`, submit another `ListRules` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
** [Rules](#API_wafRegional_ListRules_ResponseSyntax) **
An array of [RuleSummary](API_wafRegional_RuleSummary.md) objects.
Type: Array of [RuleSummary](API_wafRegional_RuleSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListRules)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListRules)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListRules)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListRules)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListRules)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListRules)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListRules)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListRules)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListRules)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListRules)
# ListSizeConstraintSets
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [SizeConstraintSetSummary](API_wafRegional_SizeConstraintSetSummary.md) objects.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListSizeConstraintSets_RequestSyntax) **
Specifies the number of `SizeConstraintSet` objects that you want AWS WAF to return for this request. If you have more `SizeConstraintSets` objects than the number you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `SizeConstraintSet` objects.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListSizeConstraintSets_RequestSyntax) **
If you specify a value for `Limit` and you have more `SizeConstraintSets` than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `SizeConstraintSets`. For the second and subsequent `ListSizeConstraintSets` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `SizeConstraintSets`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"NextMarker": "string",
"SizeConstraintSets": [
{
"Name": "string",
"SizeConstraintSetId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextMarker](#API_wafRegional_ListSizeConstraintSets_ResponseSyntax) **
If you have more `SizeConstraintSet` objects than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `SizeConstraintSet` objects, submit another `ListSizeConstraintSets` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
** [SizeConstraintSets](#API_wafRegional_ListSizeConstraintSets_ResponseSyntax) **
An array of [SizeConstraintSetSummary](API_wafRegional_SizeConstraintSetSummary.md) objects.
Type: Array of [SizeConstraintSetSummary](API_wafRegional_SizeConstraintSetSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListSizeConstraintSets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListSizeConstraintSets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListSizeConstraintSets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListSizeConstraintSets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListSizeConstraintSets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListSizeConstraintSets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListSizeConstraintSets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListSizeConstraintSets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListSizeConstraintSets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListSizeConstraintSets)
# ListSqlInjectionMatchSets
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md) objects.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListSqlInjectionMatchSets_RequestSyntax) **
Specifies the number of [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md) objects that you want AWS WAF to return for this request. If you have more `SqlInjectionMatchSet` objects than the number you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `Rules`.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListSqlInjectionMatchSets_RequestSyntax) **
If you specify a value for `Limit` and you have more [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md) objects than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `SqlInjectionMatchSets`. For the second and subsequent `ListSqlInjectionMatchSets` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `SqlInjectionMatchSets`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"NextMarker": "string",
"SqlInjectionMatchSets": [
{
"Name": "string",
"SqlInjectionMatchSetId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextMarker](#API_wafRegional_ListSqlInjectionMatchSets_ResponseSyntax) **
If you have more [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md) objects than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `SqlInjectionMatchSet` objects, submit another `ListSqlInjectionMatchSets` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
** [SqlInjectionMatchSets](#API_wafRegional_ListSqlInjectionMatchSets_ResponseSyntax) **
An array of [SqlInjectionMatchSetSummary](API_wafRegional_SqlInjectionMatchSetSummary.md) objects.
Type: Array of [SqlInjectionMatchSetSummary](API_wafRegional_SqlInjectionMatchSetSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListSqlInjectionMatchSets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListSqlInjectionMatchSets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListSqlInjectionMatchSets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListSqlInjectionMatchSets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListSqlInjectionMatchSets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListSqlInjectionMatchSets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListSqlInjectionMatchSets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListSqlInjectionMatchSets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListSqlInjectionMatchSets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListSqlInjectionMatchSets)
# ListSubscribedRuleGroups
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [RuleGroup](API_wafRegional_RuleGroup.md) objects that you are subscribed to.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListSubscribedRuleGroups_RequestSyntax) **
Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of objects.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListSubscribedRuleGroups_RequestSyntax) **
If you specify a value for `Limit` and you have more `ByteMatchSets`subscribed rule groups than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent `ListSubscribedRuleGroupsRequest` requests, specify the value of `NextMarker` from the previous response to get information about another batch of subscribed rule groups.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"NextMarker": "string",
"RuleGroups": [
{
"MetricName": "string",
"Name": "string",
"RuleGroupId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextMarker](#API_wafRegional_ListSubscribedRuleGroups_ResponseSyntax) **
If you have more objects than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more objects, submit another `ListSubscribedRuleGroups` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
** [RuleGroups](#API_wafRegional_ListSubscribedRuleGroups_ResponseSyntax) **
An array of [RuleGroup](API_wafRegional_RuleGroup.md) objects.
Type: Array of [SubscribedRuleGroupSummary](API_wafRegional_SubscribedRuleGroupSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListSubscribedRuleGroups)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListSubscribedRuleGroups)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListSubscribedRuleGroups)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListSubscribedRuleGroups)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListSubscribedRuleGroups)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListSubscribedRuleGroups)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListSubscribedRuleGroups)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListSubscribedRuleGroups)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListSubscribedRuleGroups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListSubscribedRuleGroups)
# ListTagsForResource
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Retrieves the tags associated with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string",
"ResourceARN": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListTagsForResource_RequestSyntax) **
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListTagsForResource_RequestSyntax) **
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
** [ResourceARN](#API_wafRegional_ListTagsForResource_RequestSyntax) **
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"NextMarker": "string",
"TagInfoForResource": {
"ResourceARN": "string",
"TagList": [
{
"Key": "string",
"Value": "string"
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextMarker](#API_wafRegional_ListTagsForResource_ResponseSyntax) **
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
** [TagInfoForResource](#API_wafRegional_ListTagsForResource_ResponseSyntax) **
Type: [TagInfoForResource](API_wafRegional_TagInfoForResource.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFBadRequestException **
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** 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\$1STRING, 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFTagOperationException **
HTTP Status Code: 400
** WAFTagOperationInternalErrorException **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListTagsForResource)
# ListWebACLs
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [WebACLSummary](API_wafRegional_WebACLSummary.md) objects in the response.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListWebACLs_RequestSyntax) **
Specifies the number of `WebACL` objects that you want AWS WAF to return for this request. If you have more `WebACL` objects than the number that you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `WebACL` objects.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListWebACLs_RequestSyntax) **
If you specify a value for `Limit` and you have more `WebACL` objects than the number that you specify for `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `WebACL` objects. For the second and subsequent `ListWebACLs` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `WebACL` objects.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"NextMarker": "string",
"WebACLs": [
{
"Name": "string",
"WebACLId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextMarker](#API_wafRegional_ListWebACLs_ResponseSyntax) **
If you have more `WebACL` objects than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `WebACL` objects, submit another `ListWebACLs` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
** [WebACLs](#API_wafRegional_ListWebACLs_ResponseSyntax) **
An array of [WebACLSummary](API_wafRegional_WebACLSummary.md) objects.
Type: Array of [WebACLSummary](API_wafRegional_WebACLSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListWebACLs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListWebACLs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListWebACLs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListWebACLs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListWebACLs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListWebACLs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListWebACLs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListWebACLs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListWebACLs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListWebACLs)
# ListXssMatchSets
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of [XssMatchSet](API_wafRegional_XssMatchSet.md) objects.
## Request Syntax
```
{
"Limit": number,
"NextMarker": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Limit](#API_wafRegional_ListXssMatchSets_RequestSyntax) **
Specifies the number of [XssMatchSet](API_wafRegional_XssMatchSet.md) objects that you want AWS WAF to return for this request. If you have more `XssMatchSet` objects than the number you specify for `Limit`, the response includes a `NextMarker` value that you can use to get another batch of `Rules`.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [NextMarker](#API_wafRegional_ListXssMatchSets_RequestSyntax) **
If you specify a value for `Limit` and you have more [XssMatchSet](API_wafRegional_XssMatchSet.md) objects than the value of `Limit`, AWS WAF returns a `NextMarker` value in the response that allows you to list another group of `XssMatchSets`. For the second and subsequent `ListXssMatchSets` requests, specify the value of `NextMarker` from the previous response to get information about another batch of `XssMatchSets`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"NextMarker": "string",
"XssMatchSets": [
{
"Name": "string",
"XssMatchSetId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextMarker](#API_wafRegional_ListXssMatchSets_ResponseSyntax) **
If you have more [XssMatchSet](API_wafRegional_XssMatchSet.md) objects than the number that you specified for `Limit` in the request, the response includes a `NextMarker` value. To list more `XssMatchSet` objects, submit another `ListXssMatchSets` request, and specify the `NextMarker` value from the response in the `NextMarker` value in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
** [XssMatchSets](#API_wafRegional_ListXssMatchSets_ResponseSyntax) **
An array of [XssMatchSetSummary](API_wafRegional_XssMatchSetSummary.md) objects.
Type: Array of [XssMatchSetSummary](API_wafRegional_XssMatchSetSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/ListXssMatchSets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/ListXssMatchSets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/ListXssMatchSets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/ListXssMatchSets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/ListXssMatchSets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/ListXssMatchSets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/ListXssMatchSets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/ListXssMatchSets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/ListXssMatchSets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/ListXssMatchSets)
# PutLoggingConfiguration
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Associates a [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md) with a specified web ACL.
You can access information about all traffic that AWS WAF inspects using the following steps:
1. Create an Amazon Data Firehose.
Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).
Give the data firehose a name that starts with the prefix `aws-waf-logs-`. For example, `aws-waf-logs-us-east-2-analytics`.
**Note**
Do not create the data firehose using a `Kinesis stream` as your source.
1. Associate that firehose to your web ACL using a `PutLoggingConfiguration` request.
When you successfully enable logging using a `PutLoggingConfiguration` request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Data Firehose. For more information, see [Logging Web ACL Traffic Information](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the * AWS WAF Developer Guide*.
## Request Syntax
```
{
"LoggingConfiguration": {
"LogDestinationConfigs": [ "string" ],
"RedactedFields": [
{
"Data": "string",
"Type": "string"
}
],
"ResourceArn": "string"
}
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [LoggingConfiguration](#API_wafRegional_PutLoggingConfiguration_RequestSyntax) **
The Amazon Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor.
When specifying `Type` in `RedactedFields`, you must use one of the following values: `URI`, `QUERY_STRING`, `HEADER`, or `METHOD`.
Type: [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md) object
Required: Yes
## Response Syntax
```
{
"LoggingConfiguration": {
"LogDestinationConfigs": [ "string" ],
"RedactedFields": [
{
"Data": "string",
"Type": "string"
}
],
"ResourceArn": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [LoggingConfiguration](#API_wafRegional_PutLoggingConfiguration_ResponseSyntax) **
The [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md) that you submitted in the request.
Type: [LoggingConfiguration](API_wafRegional_LoggingConfiguration.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFServiceLinkedRoleErrorException **
AWS WAF is not able to access the service linked role. This can be caused by a previous `PutLoggingConfiguration` request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous `DeleteServiceLinkedRole` request, which can lock the role for 15 minutes or more. If you recently made a `DeleteServiceLinkedRole`, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/PutLoggingConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/PutLoggingConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/PutLoggingConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/PutLoggingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/PutLoggingConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/PutLoggingConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/PutLoggingConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/PutLoggingConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/PutLoggingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/PutLoggingConfiguration)
# PutPermissionPolicy
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.
The `PutPermissionPolicy` is subject to the following restrictions:
+ You can attach only one policy with each `PutPermissionPolicy` request.
+ The policy must include an `Effect`, `Action` and `Principal`.
+ `Effect` must specify `Allow`.
+ The `Action` in the policy must be `waf:UpdateWebACL`, `waf-regional:UpdateWebACL`, `waf:GetRuleGroup` and `waf-regional:GetRuleGroup` . Any extra or wildcard actions in the policy will be rejected.
+ The policy cannot include a `Resource` parameter.
+ The ARN in the request must be a valid RuleGroup ARN and the RuleGroup must exist in the same region.
+ The user making the request must be the owner of the RuleGroup.
+ Your policy must be composed using IAM Policy version 2012-10-17.
For more information, see [Policies and permissions in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html).
An example of a valid policy parameter is shown in the Examples section below.
## Request Syntax
```
{
"Policy": "string",
"ResourceArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Policy](#API_wafRegional_PutPermissionPolicy_RequestSyntax) **
The policy to attach to the specified RuleGroup.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 395000.
Pattern: `.*\S.*`
Required: Yes
** [ResourceArn](#API_wafRegional_PutPermissionPolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidPermissionPolicyException **
The operation failed because the specified policy is not in the proper format.
The policy is subject to the following restrictions:
+ You can attach only one policy with each `PutPermissionPolicy` request.
+ The policy must include an `Effect`, `Action` and `Principal`.
+ `Effect` must specify `Allow`.
+ The `Action` in the policy must be `waf:UpdateWebACL`, `waf-regional:UpdateWebACL`, `waf:GetRuleGroup` and `waf-regional:GetRuleGroup` . Any extra or wildcard actions in the policy will be rejected.
+ The policy cannot include a `Resource` parameter.
+ The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
+ The user making the request must be the owner of the RuleGroup.
+ Your policy must be composed using IAM Policy version 2012-10-17.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## Examples
### Example policy parameter - No escape characters
This example illustrates one usage of PutPermissionPolicy.
```
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::111111111111:user/MyUserName"
},
"Action": [
"waf:UpdateWebACL",
"waf-regional:UpdateWebACL",
"waf:GetRuleGroup",
"waf-regional:GetRuleGroup"
]
}
]
}
```
### Example policy parameter - ()
This example illustrates one usage of PutPermissionPolicy.
```
{\"Version\":\"2012-10-17\", \"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111111111111:user\/MyUserName\"},\"Action\":[\"waf:UpdateWebACL\",\"waf-regional:UpdateWebACL\",\"waf:GetRuleGroup\",\"waf-regional:GetRuleGroup\"]}]}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/PutPermissionPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/PutPermissionPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/PutPermissionPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/PutPermissionPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/PutPermissionPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/PutPermissionPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/PutPermissionPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/PutPermissionPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/PutPermissionPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/PutPermissionPolicy)
# TagResource
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
## Request Syntax
```
{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceARN](#API_wafRegional_TagResource_RequestSyntax) **
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: Yes
** [Tags](#API_wafRegional_TagResource_RequestSyntax) **
Type: Array of [Tag](API_wafRegional_Tag.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFBadRequestException **
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFTagOperationException **
HTTP Status Code: 400
** WAFTagOperationInternalErrorException **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/TagResource)
# UntagResource
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
## Request Syntax
```
{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceARN](#API_wafRegional_UntagResource_RequestSyntax) **
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern: `.*\S.*`
Required: Yes
** [TagKeys](#API_wafRegional_UntagResource_RequestSyntax) **
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFBadRequestException **
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** 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\$1STRING, 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFTagOperationException **
HTTP Status Code: 400
** WAFTagOperationInternalErrorException **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UntagResource)
# UpdateByteMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes [ByteMatchTuple](API_wafRegional_ByteMatchTuple.md) objects (filters) in a [ByteMatchSet](API_wafRegional_ByteMatchSet.md). 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 AWS SDKs, see `TargetString` in the [ByteMatchTuple](API_wafRegional_ByteMatchTuple.md) 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](API_wafRegional_CreateByteMatchSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of an `UpdateByteMatchSet` request.
1. 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 path) 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ByteMatchSetId": "string",
"ChangeToken": "string",
"Updates": [
{
"Action": "string",
"ByteMatchTuple": {
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"PositionalConstraint": "string",
"TargetString": blob,
"TextTransformation": "string"
}
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ByteMatchSetId](#API_wafRegional_UpdateByteMatchSet_RequestSyntax) **
The `ByteMatchSetId` of the [ByteMatchSet](API_wafRegional_ByteMatchSet.md) that you want to update. `ByteMatchSetId` is returned by [CreateByteMatchSet](API_wafRegional_CreateByteMatchSet.md) and by [ListByteMatchSets](API_wafRegional_ListByteMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [ChangeToken](#API_wafRegional_UpdateByteMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Updates](#API_wafRegional_UpdateByteMatchSet_RequestSyntax) **
An array of `ByteMatchSetUpdate` objects that you want to insert into or delete from a [ByteMatchSet](API_wafRegional_ByteMatchSet.md). For more information, see the applicable data types:
+ [ByteMatchSetUpdate](API_wafRegional_ByteMatchSetUpdate.md): Contains `Action` and `ByteMatchTuple`
+ [ByteMatchTuple](API_wafRegional_ByteMatchTuple.md): Contains `FieldToMatch`, `PositionalConstraint`, `TargetString`, and `TextTransformation`
+ [FieldToMatch](API_wafRegional_FieldToMatch.md): Contains `Data` and `Type`
Type: Array of [ByteMatchSetUpdate](API_wafRegional_ByteMatchSetUpdate.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_UpdateByteMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `UpdateByteMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UpdateByteMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UpdateByteMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UpdateByteMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UpdateByteMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UpdateByteMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UpdateByteMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UpdateByteMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UpdateByteMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UpdateByteMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UpdateByteMatchSet)
# UpdateGeoMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes [GeoMatchConstraint](API_wafRegional_GeoMatchConstraint.md) 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](API_wafRegional_GeoMatchConstraint.md#WAF-Type-wafRegional_GeoMatchConstraint-Value).
To create and configure an `GeoMatchSet`, perform the following steps:
1. Submit a [CreateGeoMatchSet](API_wafRegional_CreateGeoMatchSet.md) request.
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of an [UpdateGeoMatchSet](#API_wafRegional_UpdateGeoMatchSet) request.
1. 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"GeoMatchSetId": "string",
"Updates": [
{
"Action": "string",
"GeoMatchConstraint": {
"Type": "string",
"Value": "string"
}
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_UpdateGeoMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [GeoMatchSetId](#API_wafRegional_UpdateGeoMatchSet_RequestSyntax) **
The `GeoMatchSetId` of the [GeoMatchSet](API_wafRegional_GeoMatchSet.md) that you want to update. `GeoMatchSetId` is returned by [CreateGeoMatchSet](API_wafRegional_CreateGeoMatchSet.md) and by [ListGeoMatchSets](API_wafRegional_ListGeoMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Updates](#API_wafRegional_UpdateGeoMatchSet_RequestSyntax) **
An array of `GeoMatchSetUpdate` objects that you want to insert into or delete from an [GeoMatchSet](API_wafRegional_GeoMatchSet.md). For more information, see the applicable data types:
+ [GeoMatchSetUpdate](API_wafRegional_GeoMatchSetUpdate.md): Contains `Action` and `GeoMatchConstraint`
+ [GeoMatchConstraint](API_wafRegional_GeoMatchConstraint.md): Contains `Type` and `Value`
You can have only one `Type` and `Value` per `GeoMatchConstraint`. To add multiple countries, include multiple `GeoMatchSetUpdate` objects in your request.
Type: Array of [GeoMatchSetUpdate](API_wafRegional_GeoMatchSetUpdate.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_UpdateGeoMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `UpdateGeoMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UpdateGeoMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UpdateGeoMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UpdateGeoMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UpdateGeoMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UpdateGeoMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UpdateGeoMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UpdateGeoMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UpdateGeoMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UpdateGeoMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UpdateGeoMatchSet)
# UpdateIPSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes [IPSetDescriptor](API_wafRegional_IPSetDescriptor.md) objects in an `IPSet`. For each `IPSetDescriptor` object, you specify the following values:
+ Whether to insert or delete the object from the array. If you want to change an `IPSetDescriptor` object, you delete the existing object and add a new one.
+ The IP address version, `IPv4` or `IPv6`.
+ The IP address in CIDR notation, for example, `192.0.2.0/24` (for the range of IP addresses from `192.0.2.0` to `192.0.2.255`) or `192.0.2.44/32` (for the individual IP address `192.0.2.44`).
AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/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:
1. Submit a [CreateIPSet](API_wafRegional_CreateIPSet.md) request.
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of an [UpdateIPSet](#API_wafRegional_UpdateIPSet) request.
1. 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 the IP addresses that you want to delete. If you want to change an IP address, delete the existing IP address and add the new one.
You can update a maximum of 1,000 addresses in a single request.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"IPSetId": "string",
"Updates": [
{
"Action": "string",
"IPSetDescriptor": {
"Type": "string",
"Value": "string"
}
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_UpdateIPSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [IPSetId](#API_wafRegional_UpdateIPSet_RequestSyntax) **
The `IPSetId` of the [IPSet](API_wafRegional_IPSet.md) that you want to update. `IPSetId` is returned by [CreateIPSet](API_wafRegional_CreateIPSet.md) and by [ListIPSets](API_wafRegional_ListIPSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Updates](#API_wafRegional_UpdateIPSet_RequestSyntax) **
An array of `IPSetUpdate` objects that you want to insert into or delete from an [IPSet](API_wafRegional_IPSet.md). For more information, see the applicable data types:
+ [IPSetUpdate](API_wafRegional_IPSetUpdate.md): Contains `Action` and `IPSetDescriptor`
+ [IPSetDescriptor](API_wafRegional_IPSetDescriptor.md): Contains `Type` and `Value`
You can specify a maximum of 1,000 addresses in a single request, for example, in a single request you can insert 999 addresses and delete 1 address, but you can't insert 999 addresses and delete 2 addresses.
Type: Array of [IPSetUpdate](API_wafRegional_IPSetUpdate.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_UpdateIPSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `UpdateIPSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UpdateIPSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UpdateIPSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UpdateIPSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UpdateIPSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UpdateIPSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UpdateIPSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UpdateIPSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UpdateIPSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UpdateIPSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UpdateIPSet)
# UpdateRateBasedRule
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes [Predicate](API_wafRegional_Predicate.md) objects in a rule and updates the `RateLimit` in the rule.
Each `Predicate` object identifies a predicate, such as a [ByteMatchSet](API_wafRegional_ByteMatchSet.md) or an [IPSet](API_wafRegional_IPSet.md), 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 1,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 1,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 1,000.
By adding this `RateBasedRule` to a `WebACL`, you could limit requests to your login page without affecting the rest of your site.
## Request Syntax
```
{
"ChangeToken": "string",
"RateLimit": number,
"RuleId": "string",
"Updates": [
{
"Action": "string",
"Predicate": {
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_UpdateRateBasedRule_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [RateLimit](#API_wafRegional_UpdateRateBasedRule_RequestSyntax) **
The maximum number of requests, which have an identical value in the field specified by the `RateKey`, allowed in a five-minute period. If the number of requests exceeds the `RateLimit` and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
Type: Long
Valid Range: Minimum value of 100. Maximum value of 2000000000.
Required: Yes
** [RuleId](#API_wafRegional_UpdateRateBasedRule_RequestSyntax) **
The `RuleId` of the `RateBasedRule` that you want to update. `RuleId` is returned by `CreateRateBasedRule` and by [ListRateBasedRules](API_wafRegional_ListRateBasedRules.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Updates](#API_wafRegional_UpdateRateBasedRule_RequestSyntax) **
An array of `RuleUpdate` objects that you want to insert into or delete from a [RateBasedRule](API_wafRegional_RateBasedRule.md).
Type: Array of [RuleUpdate](API_wafRegional_RuleUpdate.md) objects
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_UpdateRateBasedRule_ResponseSyntax) **
The `ChangeToken` that you used to submit the `UpdateRateBasedRule` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UpdateRateBasedRule)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UpdateRateBasedRule)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UpdateRateBasedRule)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UpdateRateBasedRule)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UpdateRateBasedRule)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UpdateRateBasedRule)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UpdateRateBasedRule)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UpdateRateBasedRule)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UpdateRateBasedRule)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UpdateRateBasedRule)
# UpdateRegexMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes [RegexMatchTuple](API_wafRegional_RegexMatchTuple.md) objects (filters) in a [RegexMatchSet](API_wafRegional_RegexMatchSet.md). 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](API_wafRegional_RegexPatternSet.md).
+ 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:
1. Create a `RegexMatchSet.` For more information, see [CreateRegexMatchSet](API_wafRegional_CreateRegexMatchSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of an `UpdateRegexMatchSet` request.
1. 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 path) and the identifier of the `RegexPatternSet` that contain the regular expression patterns 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"RegexMatchSetId": "string",
"Updates": [
{
"Action": "string",
"RegexMatchTuple": {
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"RegexPatternSetId": "string",
"TextTransformation": "string"
}
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_UpdateRegexMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [RegexMatchSetId](#API_wafRegional_UpdateRegexMatchSet_RequestSyntax) **
The `RegexMatchSetId` of the [RegexMatchSet](API_wafRegional_RegexMatchSet.md) that you want to update. `RegexMatchSetId` is returned by [CreateRegexMatchSet](API_wafRegional_CreateRegexMatchSet.md) and by [ListRegexMatchSets](API_wafRegional_ListRegexMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Updates](#API_wafRegional_UpdateRegexMatchSet_RequestSyntax) **
An array of `RegexMatchSetUpdate` objects that you want to insert into or delete from a [RegexMatchSet](API_wafRegional_RegexMatchSet.md). For more information, see [RegexMatchTuple](API_wafRegional_RegexMatchTuple.md).
Type: Array of [RegexMatchSetUpdate](API_wafRegional_RegexMatchSetUpdate.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_UpdateRegexMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `UpdateRegexMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFDisallowedNameException **
The name specified is invalid.
HTTP Status Code: 400
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UpdateRegexMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UpdateRegexMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UpdateRegexMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UpdateRegexMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UpdateRegexMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UpdateRegexMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UpdateRegexMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UpdateRegexMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UpdateRegexMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UpdateRegexMatchSet)
# UpdateRegexPatternSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes `RegexPatternString` objects in a [RegexPatternSet](API_wafRegional_RegexPatternSet.md). For each `RegexPatternString` object, you specify the following values:
+ Whether to insert or delete the `RegexPatternString`.
+ The regular expression pattern that you want to insert or delete. For more information, see [RegexPatternSet](API_wafRegional_RegexPatternSet.md).
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:
1. Create a `RegexPatternSet.` For more information, see [CreateRegexPatternSet](API_wafRegional_CreateRegexPatternSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of an `UpdateRegexPatternSet` request.
1. 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"RegexPatternSetId": "string",
"Updates": [
{
"Action": "string",
"RegexPatternString": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_UpdateRegexPatternSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [RegexPatternSetId](#API_wafRegional_UpdateRegexPatternSet_RequestSyntax) **
The `RegexPatternSetId` of the [RegexPatternSet](API_wafRegional_RegexPatternSet.md) that you want to update. `RegexPatternSetId` is returned by [CreateRegexPatternSet](API_wafRegional_CreateRegexPatternSet.md) and by [ListRegexPatternSets](API_wafRegional_ListRegexPatternSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Updates](#API_wafRegional_UpdateRegexPatternSet_RequestSyntax) **
An array of `RegexPatternSetUpdate` objects that you want to insert into or delete from a [RegexPatternSet](API_wafRegional_RegexPatternSet.md).
Type: Array of [RegexPatternSetUpdate](API_wafRegional_RegexPatternSetUpdate.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_UpdateRegexPatternSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `UpdateRegexPatternSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** WAFInvalidRegexPatternException **
The regular expression (regex) you specified in `RegexPatternString` is invalid.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UpdateRegexPatternSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UpdateRegexPatternSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UpdateRegexPatternSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UpdateRegexPatternSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UpdateRegexPatternSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UpdateRegexPatternSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UpdateRegexPatternSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UpdateRegexPatternSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UpdateRegexPatternSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UpdateRegexPatternSet)
# UpdateRule
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes [Predicate](API_wafRegional_Predicate.md) objects in a `Rule`. Each `Predicate` object identifies a predicate, such as a [ByteMatchSet](API_wafRegional_ByteMatchSet.md) or an [IPSet](API_wafRegional_IPSet.md), 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 that 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`.
1. Create the `Rule`. See [CreateRule](API_wafRegional_CreateRule.md).
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an [UpdateRule](#API_wafRegional_UpdateRule) request.
1. Submit an `UpdateRule` request to add predicates to the `Rule`.
1. Create and update a `WebACL` that contains the `Rule`. See [CreateWebACL](API_wafRegional_CreateWebACL.md).
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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"RuleId": "string",
"Updates": [
{
"Action": "string",
"Predicate": {
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_UpdateRule_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [RuleId](#API_wafRegional_UpdateRule_RequestSyntax) **
The `RuleId` of the `Rule` that you want to update. `RuleId` is returned by `CreateRule` and by [ListRules](API_wafRegional_ListRules.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Updates](#API_wafRegional_UpdateRule_RequestSyntax) **
An array of `RuleUpdate` objects that you want to insert into or delete from a [Rule](API_wafRegional_Rule.md). For more information, see the applicable data types:
+ [RuleUpdate](API_wafRegional_RuleUpdate.md): Contains `Action` and `Predicate`
+ [Predicate](API_wafRegional_Predicate.md): Contains `DataId`, `Negated`, and `Type`
+ [FieldToMatch](API_wafRegional_FieldToMatch.md): Contains `Data` and `Type`
Type: Array of [RuleUpdate](API_wafRegional_RuleUpdate.md) objects
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_UpdateRule_ResponseSyntax) **
The `ChangeToken` that you used to submit the `UpdateRule` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UpdateRule)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UpdateRule)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UpdateRule)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UpdateRule)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UpdateRule)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UpdateRule)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UpdateRule)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UpdateRule)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UpdateRule)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UpdateRule)
# UpdateRuleGroup
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes [ActivatedRule](API_wafRegional_ActivatedRule.md) objects in a `RuleGroup`.
You can only insert `REGULAR` rules into a rule group.
You can have a maximum of ten rules per rule group.
To create and configure a `RuleGroup`, perform the following steps:
1. Create and update the `Rules` that you want to include in the `RuleGroup`. See [CreateRule](API_wafRegional_CreateRule.md).
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an [UpdateRuleGroup](#API_wafRegional_UpdateRuleGroup) request.
1. Submit an `UpdateRuleGroup` request to add `Rules` to the `RuleGroup`.
1. Create and update a `WebACL` that contains the `RuleGroup`. See [CreateWebACL](API_wafRegional_CreateWebACL.md).
If you want to replace one `Rule` with another, you delete the existing one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"RuleGroupId": "string",
"Updates": [
{
"Action": "string",
"ActivatedRule": {
"Action": {
"Type": "string"
},
"ExcludedRules": [
{
"RuleId": "string"
}
],
"OverrideAction": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_UpdateRuleGroup_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [RuleGroupId](#API_wafRegional_UpdateRuleGroup_RequestSyntax) **
The `RuleGroupId` of the [RuleGroup](API_wafRegional_RuleGroup.md) that you want to update. `RuleGroupId` is returned by [CreateRuleGroup](API_wafRegional_CreateRuleGroup.md) and by [ListRuleGroups](API_wafRegional_ListRuleGroups.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Updates](#API_wafRegional_UpdateRuleGroup_RequestSyntax) **
An array of `RuleGroupUpdate` objects that you want to insert into or delete from a [RuleGroup](API_wafRegional_RuleGroup.md).
You can only insert `REGULAR` rules into a rule group.
`ActivatedRule|OverrideAction` applies only when updating or adding a `RuleGroup` to a `WebACL`. In this case you do not use `ActivatedRule|Action`. For all other update requests, `ActivatedRule|Action` is used instead of `ActivatedRule|OverrideAction`.
Type: Array of [RuleGroupUpdate](API_wafRegional_RuleGroupUpdate.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_UpdateRuleGroup_ResponseSyntax) **
The `ChangeToken` that you used to submit the `UpdateRuleGroup` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UpdateRuleGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UpdateRuleGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UpdateRuleGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UpdateRuleGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UpdateRuleGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UpdateRuleGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UpdateRuleGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UpdateRuleGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UpdateRuleGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UpdateRuleGroup)
# UpdateSizeConstraintSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes [SizeConstraint](API_wafRegional_SizeConstraint.md) objects (filters) in a [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md). For each `SizeConstraint` object, you specify the following values:
+ Whether to insert or delete the object from the array. If you want to change a `SizeConstraintSetUpdate` object, you delete the existing object and add a new one.
+ The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the `User-Agent` header.
+ Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first `8192` bytes of your request to AWS WAF.
You can only specify a single type of TextTransformation.
+ A `ComparisonOperator` used for evaluating the selected part of the request against the specified `Size`, such as equals, greater than, less than, and so on.
+ The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.
For example, you can add a `SizeConstraintSetUpdate` object that matches web requests in which the length of the `User-Agent` header is greater than 100 bytes. You can then configure AWS WAF to block those requests.
To create and configure a `SizeConstraintSet`, perform the following steps:
1. Create a `SizeConstraintSet.` For more information, see [CreateSizeConstraintSet](API_wafRegional_CreateSizeConstraintSet.md).
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of an `UpdateSizeConstraintSet` request.
1. 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 path) 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"SizeConstraintSetId": "string",
"Updates": [
{
"Action": "string",
"SizeConstraint": {
"ComparisonOperator": "string",
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"Size": number,
"TextTransformation": "string"
}
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_UpdateSizeConstraintSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [SizeConstraintSetId](#API_wafRegional_UpdateSizeConstraintSet_RequestSyntax) **
The `SizeConstraintSetId` of the [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md) that you want to update. `SizeConstraintSetId` is returned by [CreateSizeConstraintSet](API_wafRegional_CreateSizeConstraintSet.md) and by [ListSizeConstraintSets](API_wafRegional_ListSizeConstraintSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Updates](#API_wafRegional_UpdateSizeConstraintSet_RequestSyntax) **
An array of `SizeConstraintSetUpdate` objects that you want to insert into or delete from a [SizeConstraintSet](API_wafRegional_SizeConstraintSet.md). For more information, see the applicable data types:
+ [SizeConstraintSetUpdate](API_wafRegional_SizeConstraintSetUpdate.md): Contains `Action` and `SizeConstraint`
+ [SizeConstraint](API_wafRegional_SizeConstraint.md): Contains `FieldToMatch`, `TextTransformation`, `ComparisonOperator`, and `Size`
+ [FieldToMatch](API_wafRegional_FieldToMatch.md): Contains `Data` and `Type`
Type: Array of [SizeConstraintSetUpdate](API_wafRegional_SizeConstraintSetUpdate.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_UpdateSizeConstraintSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `UpdateSizeConstraintSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UpdateSizeConstraintSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UpdateSizeConstraintSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UpdateSizeConstraintSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UpdateSizeConstraintSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UpdateSizeConstraintSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UpdateSizeConstraintSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UpdateSizeConstraintSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UpdateSizeConstraintSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UpdateSizeConstraintSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UpdateSizeConstraintSet)
# UpdateSqlInjectionMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes [SqlInjectionMatchTuple](API_wafRegional_SqlInjectionMatchTuple.md) objects (filters) in a [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md). For each `SqlInjectionMatchTuple` object, you specify the following values:
+ `Action`: Whether to insert the object into or delete the object from the array. To change a `SqlInjectionMatchTuple`, you delete the existing object and add a new one.
+ `FieldToMatch`: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
+ `TextTransformation`: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.
You can only specify a single type of TextTransformation.
You use `SqlInjectionMatchSet` objects to specify which Amazon CloudFront requests that 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](API_wafRegional_CreateSqlInjectionMatchSet.md) request.
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of an [UpdateIPSet](API_wafRegional_UpdateIPSet.md) request.
1. 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"SqlInjectionMatchSetId": "string",
"Updates": [
{
"Action": "string",
"SqlInjectionMatchTuple": {
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"TextTransformation": "string"
}
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_UpdateSqlInjectionMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [SqlInjectionMatchSetId](#API_wafRegional_UpdateSqlInjectionMatchSet_RequestSyntax) **
The `SqlInjectionMatchSetId` of the `SqlInjectionMatchSet` that you want to update. `SqlInjectionMatchSetId` is returned by [CreateSqlInjectionMatchSet](API_wafRegional_CreateSqlInjectionMatchSet.md) and by [ListSqlInjectionMatchSets](API_wafRegional_ListSqlInjectionMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Updates](#API_wafRegional_UpdateSqlInjectionMatchSet_RequestSyntax) **
An array of `SqlInjectionMatchSetUpdate` objects that you want to insert into or delete from a [SqlInjectionMatchSet](API_wafRegional_SqlInjectionMatchSet.md). For more information, see the applicable data types:
+ [SqlInjectionMatchSetUpdate](API_wafRegional_SqlInjectionMatchSetUpdate.md): Contains `Action` and `SqlInjectionMatchTuple`
+ [SqlInjectionMatchTuple](API_wafRegional_SqlInjectionMatchTuple.md): Contains `FieldToMatch` and `TextTransformation`
+ [FieldToMatch](API_wafRegional_FieldToMatch.md): Contains `Data` and `Type`
Type: Array of [SqlInjectionMatchSetUpdate](API_wafRegional_SqlInjectionMatchSetUpdate.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_UpdateSqlInjectionMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `UpdateSqlInjectionMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UpdateSqlInjectionMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UpdateSqlInjectionMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UpdateSqlInjectionMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UpdateSqlInjectionMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UpdateSqlInjectionMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UpdateSqlInjectionMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UpdateSqlInjectionMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UpdateSqlInjectionMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UpdateSqlInjectionMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UpdateSqlInjectionMatchSet)
# UpdateWebACL
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes [ActivatedRule](API_wafRegional_ActivatedRule.md) 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 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 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:
1. Create and update the predicates that you want to include in `Rules`. For more information, see [CreateByteMatchSet](API_wafRegional_CreateByteMatchSet.md), [UpdateByteMatchSet](API_wafRegional_UpdateByteMatchSet.md), [CreateIPSet](API_wafRegional_CreateIPSet.md), [UpdateIPSet](API_wafRegional_UpdateIPSet.md), [CreateSqlInjectionMatchSet](API_wafRegional_CreateSqlInjectionMatchSet.md), and [UpdateSqlInjectionMatchSet](API_wafRegional_UpdateSqlInjectionMatchSet.md).
1. Create and update the `Rules` that you want to include in the `WebACL`. For more information, see [CreateRule](API_wafRegional_CreateRule.md) and [UpdateRule](API_wafRegional_UpdateRule.md).
1. Create a `WebACL`. See [CreateWebACL](API_wafRegional_CreateWebACL.md).
1. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an [UpdateWebACL](#API_wafRegional_UpdateWebACL) request.
1. 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 an Amazon CloudFront distribution.
The `ActivatedRule` can be a rule group. If you specify a rule group as your `ActivatedRule`, you can exclude specific rules from that rule group.
If you already have a rule group associated with a web ACL and want to submit an `UpdateWebACL` request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see [ActivatedRule:ExcludedRules](API_wafRegional_ActivatedRule.md#WAF-Type-wafRegional_ActivatedRule-ExcludedRules).
Be aware that if you try to add a RATE\$1BASED rule to a web ACL without setting the rule type when first creating the rule, the [UpdateWebACL](#API_wafRegional_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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"DefaultAction": {
"Type": "string"
},
"Updates": [
{
"Action": "string",
"ActivatedRule": {
"Action": {
"Type": "string"
},
"ExcludedRules": [
{
"RuleId": "string"
}
],
"OverrideAction": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
}
],
"WebACLId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_UpdateWebACL_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [DefaultAction](#API_wafRegional_UpdateWebACL_RequestSyntax) **
Type: [WafAction](API_wafRegional_WafAction.md) object
Required: No
** [Updates](#API_wafRegional_UpdateWebACL_RequestSyntax) **
An array of updates to make to the [WebACL](API_wafRegional_WebACL.md).
An array of `WebACLUpdate` objects that you want to insert into or delete from a [WebACL](API_wafRegional_WebACL.md). For more information, see the applicable data types:
+ [WebACLUpdate](API_wafRegional_WebACLUpdate.md): Contains `Action` and `ActivatedRule`
+ [ActivatedRule](API_wafRegional_ActivatedRule.md): Contains `Action`, `OverrideAction`, `Priority`, `RuleId`, and `Type`. `ActivatedRule|OverrideAction` applies only when updating or adding a `RuleGroup` to a `WebACL`. In this case, you do not use `ActivatedRule|Action`. For all other update requests, `ActivatedRule|Action` is used instead of `ActivatedRule|OverrideAction`.
+ [WafAction](API_wafRegional_WafAction.md): Contains `Type`
Type: Array of [WebACLUpdate](API_wafRegional_WebACLUpdate.md) objects
Required: No
** [WebACLId](#API_wafRegional_UpdateWebACL_RequestSyntax) **
The `WebACLId` of the [WebACL](API_wafRegional_WebACL.md) that you want to update. `WebACLId` is returned by [CreateWebACL](API_wafRegional_CreateWebACL.md) and by [ListWebACLs](API_wafRegional_ListWebACLs.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_UpdateWebACL_ResponseSyntax) **
The `ChangeToken` that you used to submit the `UpdateWebACL` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** 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`.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
** WAFSubscriptionNotFoundException **
The specified subscription does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UpdateWebACL)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UpdateWebACL)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UpdateWebACL)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UpdateWebACL)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UpdateWebACL)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UpdateWebACL)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UpdateWebACL)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UpdateWebACL)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UpdateWebACL)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UpdateWebACL)
# UpdateXssMatchSet
**Note**
AWS WAF Classic support will end on September 30, 2025.
This is ** AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
**For the latest version of AWS WAF **, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes [XssMatchTuple](API_wafRegional_XssMatchTuple.md) objects (filters) in an [XssMatchSet](API_wafRegional_XssMatchSet.md). 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 an `XssMatchTuple`, you delete the existing object and add a new one.
+ `FieldToMatch`: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
+ `TextTransformation`: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.
You can only specify a single type of TextTransformation.
You use `XssMatchSet` objects to specify which Amazon CloudFront requests that 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:
1. Submit a [CreateXssMatchSet](API_wafRegional_CreateXssMatchSet.md) request.
1. Use [GetChangeToken](API_wafRegional_GetChangeToken.md) to get the change token that you provide in the `ChangeToken` parameter of an [UpdateIPSet](API_wafRegional_UpdateIPSet.md) request.
1. 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](https://docs.aws.amazon.com/waf/latest/developerguide/).
## Request Syntax
```
{
"ChangeToken": "string",
"Updates": [
{
"Action": "string",
"XssMatchTuple": {
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"TextTransformation": "string"
}
}
],
"XssMatchSetId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ChangeToken](#API_wafRegional_UpdateXssMatchSet_RequestSyntax) **
The value returned by the most recent call to [GetChangeToken](API_wafRegional_GetChangeToken.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
** [Updates](#API_wafRegional_UpdateXssMatchSet_RequestSyntax) **
An array of `XssMatchSetUpdate` objects that you want to insert into or delete from an [XssMatchSet](API_wafRegional_XssMatchSet.md). For more information, see the applicable data types:
+ [XssMatchSetUpdate](API_wafRegional_XssMatchSetUpdate.md): Contains `Action` and `XssMatchTuple`
+ [XssMatchTuple](API_wafRegional_XssMatchTuple.md): Contains `FieldToMatch` and `TextTransformation`
+ [FieldToMatch](API_wafRegional_FieldToMatch.md): Contains `Data` and `Type`
Type: Array of [XssMatchSetUpdate](API_wafRegional_XssMatchSetUpdate.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
** [XssMatchSetId](#API_wafRegional_UpdateXssMatchSet_RequestSyntax) **
The `XssMatchSetId` of the `XssMatchSet` that you want to update. `XssMatchSetId` is returned by [CreateXssMatchSet](API_wafRegional_CreateXssMatchSet.md) and by [ListXssMatchSets](API_wafRegional_ListXssMatchSets.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
{
"ChangeToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ChangeToken](#API_wafRegional_UpdateXssMatchSet_ResponseSyntax) **
The `ChangeToken` that you used to submit the `UpdateXssMatchSet` request. You can also use this value to query the status of the request. For more information, see [GetChangeTokenStatus](API_wafRegional_GetChangeTokenStatus.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** WAFInternalErrorException **
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
** WAFInvalidAccountException **
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
** WAFInvalidOperationException **
The operation failed because there was nothing to do. For example:
+ You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`.
+ You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`.
+ You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`.
+ You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`.
+ You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
HTTP Status Code: 400
** 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\$1STRING, 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.
HTTP Status Code: 400
** 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 [AWS WAF Classic quotas](https://docs.aws.amazon.com/waf/latest/developerguide/classic-limits.html) in the * AWS WAF Developer Guide*.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
** WAFNonexistentItemException **
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
** WAFStaleDataException **
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waf-regional-2016-11-28/UpdateXssMatchSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waf-regional-2016-11-28/UpdateXssMatchSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waf-regional-2016-11-28/UpdateXssMatchSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waf-regional-2016-11-28/UpdateXssMatchSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waf-regional-2016-11-28/UpdateXssMatchSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waf-regional-2016-11-28/UpdateXssMatchSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waf-regional-2016-11-28/UpdateXssMatchSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waf-regional-2016-11-28/UpdateXssMatchSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waf-regional-2016-11-28/UpdateXssMatchSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waf-regional-2016-11-28/UpdateXssMatchSet)