pe":"WAFReferencedItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a RegexMatchSet. You can't delete a `RegexMatchSet` if it's still used in any `Rules` or if it still includes any `RegexMatchTuples` objects (any filters).

If you just want to remove a `RegexMatchSet` from a `Rule`, use UpdateRule.

To permanently delete a `RegexMatchSet`, perform the following steps:

1. Update the `RegexMatchSet` to remove filters, if any. For more information, see UpdateRegexMatchSet.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of a `DeleteRegexMatchSet` request.

3. Submit a `DeleteRegexMatchSet` request.

" }, "DeleteRegexPatternSet":{ "name":"DeleteRegexPatternSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRegexPatternSetRequest"}, "output":{"shape":"DeleteRegexPatternSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a RegexPatternSet. You can't delete a `RegexPatternSet` if it's still used in any `RegexMatchSet` or if the `RegexPatternSet` is not empty.

" }, "DeleteRule":{ "name":"DeleteRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRuleRequest"}, "output":{"shape":"DeleteRuleResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFNonEmptyEntityException"}, {"shape":"WAFTagOperationException"}, {"shape":"WAFTagOperationInternalErrorException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a Rule. You can't delete a `Rule` if it's still used in any `WebACL` objects or if it still includes any predicates, such as `ByteMatchSet` objects.

If you just want to remove a `Rule` from a `WebACL`, use UpdateWebACL.

To permanently delete a `Rule` from AWS WAF, perform the following steps:

1. Update the `Rule` to remove predicates, if any. For more information, see UpdateRule.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of a `DeleteRule` request.

3. Submit a `DeleteRule` request.

" }, "DeleteRuleGroup":{ "name":"DeleteRuleGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRuleGroupRequest"}, "output":{"shape":"DeleteRuleGroupResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFNonEmptyEntityException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFTagOperationException"}, {"shape":"WAFTagOperationInternalErrorException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a RuleGroup. 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.

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.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of a `DeleteRuleGroup` request.

3. Submit a `DeleteRuleGroup` request.

" }, "DeleteSizeConstraintSet":{ "name":"DeleteSizeConstraintSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSizeConstraintSetRequest"}, "output":{"shape":"DeleteSizeConstraintSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a SizeConstraintSet. You can't delete a `SizeConstraintSet` if it's still used in any `Rules` or if it still includes any SizeConstraint objects (any filters).

If you just want to remove a `SizeConstraintSet` from a `Rule`, use UpdateRule.

To permanently delete a `SizeConstraintSet`, perform the following steps:

1. Update the `SizeConstraintSet` to remove filters, if any. For more information, see UpdateSizeConstraintSet.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of a `DeleteSizeConstraintSet` request.

3. Submit a `DeleteSizeConstraintSet` request.

" }, "DeleteSqlInjectionMatchSet":{ "name":"DeleteSqlInjectionMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSqlInjectionMatchSetRequest"}, "output":{"shape":"DeleteSqlInjectionMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a SqlInjectionMatchSet. You can't delete a `SqlInjectionMatchSet` if it's still used in any `Rules` or if it still contains any SqlInjectionMatchTuple objects.

If you just want to remove a `SqlInjectionMatchSet` from a `Rule`, use UpdateRule.

To permanently delete a `SqlInjectionMatchSet` from AWS WAF, perform the following steps:

1. Update the `SqlInjectionMatchSet` to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of a `DeleteSqlInjectionMatchSet` request.

3. Submit a `DeleteSqlInjectionMatchSet` request.

" }, "DeleteWebACL":{ "name":"DeleteWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteWebACLRequest"}, "output":{"shape":"DeleteWebACLResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFNonEmptyEntityException"}, {"shape":"WAFTagOperationException"}, {"shape":"WAFTagOperationInternalErrorException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

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

To delete a `WebACL`, perform the following steps:

1. Update the `WebACL` to remove `Rules`, if any. For more information, see UpdateWebACL.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of a `DeleteWebACL` request.

3. Submit a `DeleteWebACL` request.

" }, "DeleteXssMatchSet":{ "name":"DeleteXssMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteXssMatchSetRequest"}, "output":{"shape":"DeleteXssMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes an XssMatchSet. You can't delete an `XssMatchSet` if it's still used in any `Rules` or if it still contains any XssMatchTuple objects.

If you just want to remove an `XssMatchSet` from a `Rule`, use UpdateRule.

To permanently delete an `XssMatchSet` from AWS WAF, perform the following steps:

1. Update the `XssMatchSet` to remove filters, if any. For more information, see UpdateXssMatchSet.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of a `DeleteXssMatchSet` request.

3. Submit a `DeleteXssMatchSet` request.

" }, "DisassociateWebACL":{ "name":"DisassociateWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateWebACLRequest"}, "output":{"shape":"DisassociateWebACLResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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.

" }, "GetByteMatchSet":{ "name":"GetByteMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetByteMatchSetRequest"}, "output":{"shape":"GetByteMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the ByteMatchSet specified by `ByteMatchSetId`.

" }, "GetChangeToken":{ "name":"GetChangeToken", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetChangeTokenRequest"}, "output":{"shape":"GetChangeTokenResponse"}, "errors":[ {"shape":"WAFInternalErrorException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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.

" }, "GetChangeTokenStatus":{ "name":"GetChangeTokenStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetChangeTokenStatusRequest"}, "output":{"shape":"GetChangeTokenStatusResponse"}, "errors":[ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInternalErrorException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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. `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.

" }, "GetGeoMatchSet":{ "name":"GetGeoMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetGeoMatchSetRequest"}, "output":{"shape":"GetGeoMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the GeoMatchSet that is specified by `GeoMatchSetId`.

" }, "GetIPSet":{ "name":"GetIPSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetIPSetRequest"}, "output":{"shape":"GetIPSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the IPSet that is specified by `IPSetId`.

" }, "GetLoggingConfiguration":{ "name":"GetLoggingConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetLoggingConfigurationRequest"}, "output":{"shape":"GetLoggingConfigurationResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the LoggingConfiguration for the specified web ACL.

" }, "GetPermissionPolicy":{ "name":"GetPermissionPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPermissionPolicyRequest"}, "output":{"shape":"GetPermissionPolicyResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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.

" }, "GetRateBasedRule":{ "name":"GetRateBasedRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRateBasedRuleRequest"}, "output":{"shape":"GetRateBasedRuleResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the RateBasedRule that is specified by the `RuleId` that you included in the `GetRateBasedRule` request.

" }, "GetRateBasedRuleManagedKeys":{ "name":"GetRateBasedRuleManagedKeys", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRateBasedRuleManagedKeysRequest"}, "output":{"shape":"GetRateBasedRuleManagedKeysResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInvalidParameterException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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 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.

" }, "GetRegexMatchSet":{ "name":"GetRegexMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRegexMatchSetRequest"}, "output":{"shape":"GetRegexMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the RegexMatchSet specified by `RegexMatchSetId`.

" }, "GetRegexPatternSet":{ "name":"GetRegexPatternSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRegexPatternSetRequest"}, "output":{"shape":"GetRegexPatternSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the RegexPatternSet specified by `RegexPatternSetId`.

" }, "GetRule":{ "name":"GetRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRuleRequest"}, "output":{"shape":"GetRuleResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

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

" }, "GetRuleGroup":{ "name":"GetRuleGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRuleGroupRequest"}, "output":{"shape":"GetRuleGroupResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the RuleGroup that is specified by the `RuleGroupId` that you included in the `GetRuleGroup` request.

To view the rules in a rule group, use ListActivatedRulesInRuleGroup.

" }, "GetSampledRequests":{ "name":"GetSampledRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSampledRequestsRequest"}, "output":{"shape":"GetSampledRequestsResponse"}, "errors":[ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInternalErrorException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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 a CloudFront distribution) received 5,000 requests before the specified time range elapsed, `GetSampledRequests` returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

" }, "GetSizeConstraintSet":{ "name":"GetSizeConstraintSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSizeConstraintSetRequest"}, "output":{"shape":"GetSizeConstraintSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the SizeConstraintSet specified by `SizeConstraintSetId`.

" }, "GetSqlInjectionMatchSet":{ "name":"GetSqlInjectionMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSqlInjectionMatchSetRequest"}, "output":{"shape":"GetSqlInjectionMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the SqlInjectionMatchSet that is specified by `SqlInjectionMatchSetId`.

" }, "GetWebACL":{ "name":"GetWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetWebACLRequest"}, "output":{"shape":"GetWebACLResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the WebACL that is specified by `WebACLId`.

" }, "GetWebACLForResource":{ "name":"GetWebACLForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetWebACLForResourceRequest"}, "output":{"shape":"GetWebACLForResourceResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFUnavailableEntityException"} ], "documentation":"

This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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.

" }, "GetXssMatchSet":{ "name":"GetXssMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetXssMatchSetRequest"}, "output":{"shape":"GetXssMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the XssMatchSet that is specified by `XssMatchSetId`.

" }, "ListActivatedRulesInRuleGroup":{ "name":"ListActivatedRulesInRuleGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListActivatedRulesInRuleGroupRequest"}, "output":{"shape":"ListActivatedRulesInRuleGroupResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInvalidParameterException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of ActivatedRule objects.

" }, "ListByteMatchSets":{ "name":"ListByteMatchSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListByteMatchSetsRequest"}, "output":{"shape":"ListByteMatchSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of ByteMatchSetSummary objects.

" }, "ListGeoMatchSets":{ "name":"ListGeoMatchSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListGeoMatchSetsRequest"}, "output":{"shape":"ListGeoMatchSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of GeoMatchSetSummary objects in the response.

" }, "ListIPSets":{ "name":"ListIPSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListIPSetsRequest"}, "output":{"shape":"ListIPSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of IPSetSummary objects in the response.

" }, "ListLoggingConfigurations":{ "name":"ListLoggingConfigurations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListLoggingConfigurationsRequest"}, "output":{"shape":"ListLoggingConfigurationsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInvalidParameterException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of LoggingConfiguration objects.

" }, "ListRateBasedRules":{ "name":"ListRateBasedRules", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRateBasedRulesRequest"}, "output":{"shape":"ListRateBasedRulesResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of RuleSummary objects.

" }, "ListRegexMatchSets":{ "name":"ListRegexMatchSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRegexMatchSetsRequest"}, "output":{"shape":"ListRegexMatchSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of RegexMatchSetSummary objects.

" }, "ListRegexPatternSets":{ "name":"ListRegexPatternSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRegexPatternSetsRequest"}, "output":{"shape":"ListRegexPatternSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of RegexPatternSetSummary objects.

" }, "ListResourcesForWebACL":{ "name":"ListResourcesForWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListResourcesForWebACLRequest"}, "output":{"shape":"ListResourcesForWebACLResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInvalidParameterException"} ], "documentation":"

This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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.

" }, "ListRuleGroups":{ "name":"ListRuleGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRuleGroupsRequest"}, "output":{"shape":"ListRuleGroupsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of RuleGroup objects.

" }, "ListRules":{ "name":"ListRules", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRulesRequest"}, "output":{"shape":"ListRulesResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of RuleSummary objects.

" }, "ListSizeConstraintSets":{ "name":"ListSizeConstraintSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSizeConstraintSetsRequest"}, "output":{"shape":"ListSizeConstraintSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of SizeConstraintSetSummary objects.

" }, "ListSqlInjectionMatchSets":{ "name":"ListSqlInjectionMatchSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSqlInjectionMatchSetsRequest"}, "output":{"shape":"ListSqlInjectionMatchSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of SqlInjectionMatchSet objects.

" }, "ListSubscribedRuleGroups":{ "name":"ListSubscribedRuleGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSubscribedRuleGroupsRequest"}, "output":{"shape":"ListSubscribedRuleGroupsResponse"}, "errors":[ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInternalErrorException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of RuleGroup objects that you are subscribed to.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFBadRequestException"}, {"shape":"WAFTagOperationException"}, {"shape":"WAFTagOperationInternalErrorException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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.

" }, "ListWebACLs":{ "name":"ListWebACLs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListWebACLsRequest"}, "output":{"shape":"ListWebACLsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of WebACLSummary objects in the response.

" }, "ListXssMatchSets":{ "name":"ListXssMatchSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListXssMatchSetsRequest"}, "output":{"shape":"ListXssMatchSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of XssMatchSet objects.

" }, "PutLoggingConfiguration":{ "name":"PutLoggingConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutLoggingConfigurationRequest"}, "output":{"shape":"PutLoggingConfigurationResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFServiceLinkedRoleErrorException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Associates a LoggingConfiguration with a specified web ACL.

You can access information about all traffic that AWS WAF inspects using the following steps:

1. Create an Amazon Kinesis 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).

   Do not create the data firehose using a `Kinesis stream` as your source.

2. Associate that firehose to your web ACL using a `PutLoggingConfiguration` request.

When you successfully enable logging using a `PutLoggingConfiguration` request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

" }, "PutPermissionPolicy":{ "name":"PutPermissionPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutPermissionPolicyRequest"}, "output":{"shape":"PutPermissionPolicyResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInvalidPermissionPolicyException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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 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.

For more information, see IAM Policies.

An example of a valid policy parameter is shown in the Examples section below.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFBadRequestException"}, {"shape":"WAFTagOperationException"}, {"shape":"WAFTagOperationInternalErrorException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFBadRequestException"}, {"shape":"WAFTagOperationException"}, {"shape":"WAFTagOperationInternalErrorException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

" }, "UpdateByteMatchSet":{ "name":"UpdateByteMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateByteMatchSetRequest"}, "output":{"shape":"UpdateByteMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each `ByteMatchTuple` object, you specify the following values:

- Whether to insert or delete the object from the array. If you want to change a `ByteMatchSetUpdate` object, you delete the existing object and add a new one.

- The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the `User-Agent` header.

- The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see `TargetString` in the ByteMatchTuple data type.

- Where to look, such as at the beginning or the end of a query string.

- Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a `ByteMatchSetUpdate` object that matches web requests in which `User-Agent` headers contain the string `BadBot`. You can then configure AWS WAF to block those requests.

To create and configure a `ByteMatchSet`, perform the following steps:

1. Create a `ByteMatchSet.` For more information, see CreateByteMatchSet.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of an `UpdateByteMatchSet` request.

3. Submit an `UpdateByteMatchSet` request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

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

" }, "UpdateGeoMatchSet":{ "name":"UpdateGeoMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateGeoMatchSetRequest"}, "output":{"shape":"UpdateGeoMatchSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes GeoMatchConstraint objects in an `GeoMatchSet`. For each `GeoMatchConstraint` object, you specify the following values:

- Whether to insert or delete the object from the array. If you want to change an `GeoMatchConstraint` object, you delete the existing object and add a new one.

- The `Type`. The only valid value for `Type` is `Country`.

- The `Value`, which is a two character code for the country to add to the `GeoMatchConstraint` object. Valid codes are listed in GeoMatchConstraint$Value.

To create and configure an `GeoMatchSet`, perform the following steps:

1. Submit a CreateGeoMatchSet request.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of an UpdateGeoMatchSet request.

3. 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.

" }, "UpdateIPSet":{ "name":"UpdateIPSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateIPSetRequest"}, "output":{"shape":"UpdateIPSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes IPSetDescriptor objects in an `IPSet`. For each `IPSetDescriptor` object, you specify the following values:

- Whether to insert or delete the object from the array. If you want to change an `IPSetDescriptor` object, you delete the existing object and add a new one.

- The IP address version, `IPv4` or `IPv6`.

- The IP address in CIDR notation, for example, `192.0.2.0/24` (for the range of IP addresses from `192.0.2.0` to `192.0.2.255`) or `192.0.2.44/32` (for the individual IP address `192.0.2.44`).

AWS WAF supports 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.

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

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of an UpdateIPSet request.

3. Submit an `UpdateIPSet` request to specify the IP addresses that you want AWS WAF to watch for.

When you update an `IPSet`, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

You can insert a maximum of 1000 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.

" }, "UpdateRateBasedRule":{ "name":"UpdateRateBasedRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRateBasedRuleRequest"}, "output":{"shape":"UpdateRateBasedRuleResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes Predicate objects in a rule and updates the `RateLimit` in the rule.

Each `Predicate` object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The `RateLimit` specifies the number of requests every five minutes that triggers the rule.

If you add more than one predicate to a `RateBasedRule`, a request must match all the predicates and exceed the `RateLimit` to be counted or blocked. For example, suppose you add the following to a `RateBasedRule`:

- An `IPSet` that matches the IP address `192.0.2.44/32`

- A `ByteMatchSet` that matches `BadBot` in the `User-Agent` header

Further, you specify a `RateLimit` of 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.

" }, "UpdateRegexMatchSet":{ "name":"UpdateRegexMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRegexMatchSetRequest"}, "output":{"shape":"UpdateRegexMatchSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFDisallowedNameException"}, {"shape":"WAFLimitsExceededException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each `RegexMatchSetUpdate` object, you specify the following values:

- Whether to insert or delete the object from the array. If you want to change a `RegexMatchSetUpdate` object, you delete the existing object and add a new one.

- The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the `User-Agent` header.

- The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

- Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can create a `RegexPatternSet` that matches any requests with `User-Agent` headers that contain the string `B[a@]dB[o0]t`. You can then configure AWS WAF to reject those requests.

To create and configure a `RegexMatchSet`, perform the following steps:

1. Create a `RegexMatchSet.` For more information, see CreateRegexMatchSet.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of an `UpdateRegexMatchSet` request.

3. Submit an `UpdateRegexMatchSet` request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the `RegexPatternSet` that contain the regular expression patters you want AWS WAF to watch for.

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

" }, "UpdateRegexPatternSet":{ "name":"UpdateRegexPatternSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRegexPatternSetRequest"}, "output":{"shape":"UpdateRegexPatternSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFLimitsExceededException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidRegexPatternException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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. 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.

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.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of an `UpdateRegexPatternSet` request.

3. 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.

" }, "UpdateRule":{ "name":"UpdateRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRuleRequest"}, "output":{"shape":"UpdateRuleResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes Predicate objects in a `Rule`. Each `Predicate` object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a `Rule`, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose 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`.

2. Create the `Rule`. See CreateRule.

3. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an UpdateRule request.

4. Submit an `UpdateRule` request to add predicates to the `Rule`.

5. Create and update a `WebACL` that contains the `Rule`. See CreateWebACL.

If you want to replace one `ByteMatchSet` or `IPSet` with another, you delete the existing one and add the new one.

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

" }, "UpdateRuleGroup":{ "name":"UpdateRuleGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRuleGroupRequest"}, "output":{"shape":"UpdateRuleGroupResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFLimitsExceededException"}, {"shape":"WAFInvalidParameterException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes ActivatedRule 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.

2. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an UpdateRuleGroup request.

3. Submit an `UpdateRuleGroup` request to add `Rules` to the `RuleGroup`.

4. Create and update a `WebACL` that contains the `RuleGroup`. See CreateWebACL.

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.

" }, "UpdateSizeConstraintSet":{ "name":"UpdateSizeConstraintSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSizeConstraintSetRequest"}, "output":{"shape":"UpdateSizeConstraintSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each `SizeConstraint` object, you specify the following values:

- Whether to insert or delete the object from the array. If you want to change a `SizeConstraintSetUpdate` object, you delete the existing object and add a new one.

- The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the `User-Agent` header.

- Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first `8192` bytes of your request to AWS WAF.

  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.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of an `UpdateSizeConstraintSet` request.

3. Submit an `UpdateSizeConstraintSet` request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

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

" }, "UpdateSqlInjectionMatchSet":{ "name":"UpdateSqlInjectionMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSqlInjectionMatchSetRequest"}, "output":{"shape":"UpdateSqlInjectionMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each `SqlInjectionMatchTuple` object, you specify the following values:

- `Action`: Whether to insert the object into or delete the object from the array. To change a `SqlInjectionMatchTuple`, you delete the existing object and add a new one.

- `FieldToMatch`: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header 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 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 request.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of an UpdateIPSet request.

3. Submit an `UpdateSqlInjectionMatchSet` request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.

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

" }, "UpdateWebACL":{ "name":"UpdateWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateWebACLRequest"}, "output":{"shape":"UpdateWebACLResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"}, {"shape":"WAFSubscriptionNotFoundException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes ActivatedRule objects in a `WebACL`. Each `Rule` identifies web requests that you want to allow, block, or count. When you update a `WebACL`, you specify the following values:

- A default action for the `WebACL`, either `ALLOW` or `BLOCK`. AWS WAF performs the default action if a request doesn't match the criteria in any of the `Rules` in a `WebACL`.

- The `Rules` that you want to add 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, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

2. Create and update the `Rules` that you want to include in the `WebACL`. For more information, see CreateRule and UpdateRule.

3. Create a `WebACL`. See CreateWebACL.

4. Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an UpdateWebACL request.

5. Submit an `UpdateWebACL` request to specify the `Rules` that you want to include in the `WebACL`, to specify the default action, and to associate the `WebACL` with a CloudFront distribution.

   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 .

Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.

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

" }, "UpdateXssMatchSet":{ "name":"UpdateXssMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateXssMatchSetRequest"}, "output":{"shape":"UpdateXssMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each `XssMatchTuple` object, you specify the following values:

- `Action`: Whether to insert the object into or delete the object from the array. To change 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 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 request.

2. Use GetChangeToken to get the change token that you provide in the `ChangeToken` parameter of an UpdateIPSet request.

3. 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.

" } }, "shapes":{ "Action":{"type":"string"}, "ActivatedRule":{ "type":"structure", "required":[ "Priority", "RuleId" ], "members":{ "Priority":{ "shape":"RulePriority", "documentation":"

Specifies the order in which the `Rules` in a `WebACL` are evaluated. Rules with a lower value for `Priority` are evaluated before `Rules` with a higher value. The value must be a unique integer. If you add multiple `Rules` to a `WebACL`, the values don't need to be consecutive.

" }, "RuleId":{ "shape":"ResourceId", "documentation":"

The `RuleId` for a `Rule`. You use `RuleId` to get more information about a `Rule` (see GetRule), update a `Rule` (see UpdateRule), insert a `Rule` into a `WebACL` or delete a one from a `WebACL` (see UpdateWebACL), or delete a `Rule` from AWS WAF (see DeleteRule).

`RuleId` is returned by CreateRule and by ListRules.

" }, "Action":{ "shape":"WafAction", "documentation":"

Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the `Rule`. Valid values for `Action` include the following:

- `ALLOW`: CloudFront responds with the requested object.

- `BLOCK`: CloudFront responds with an HTTP 403 (Forbidden) status code.

- `COUNT`: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

`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`.

" }, "OverrideAction":{ "shape":"WafOverrideAction", "documentation":"

Use the `OverrideAction` to test your `RuleGroup`.

Any rule in a `RuleGroup` can potentially block a request. If you set the `OverrideAction` to `None`, the `RuleGroup` will block a request if any individual rule in the `RuleGroup` matches the request and is configured to block that request. However if you first want to test the `RuleGroup`, set the `OverrideAction` to `Count`. The `RuleGroup` will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.

`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":{ "shape":"WafRuleType", "documentation":"

The rule type, either `REGULAR`, as defined by Rule, `RATE_BASED`, as defined by RateBasedRule, or `GROUP`, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

" }, "ExcludedRules":{ "shape":"ExcludedRules", "documentation":"

An array of rules to exclude from a rule group. This is applicable only when the `ActivatedRule` refers to a `RuleGroup`.

Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.

Specifying `ExcludedRules` does not remove those rules from the rule group. Rather, it changes the action for the rules to `COUNT`. Therefore, requests that match an `ExcludedRule` are counted but not blocked. The `RuleGroup` owner will receive COUNT metrics for each `ExcludedRule`.

If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

1. Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.

2. Submit an UpdateWebACL request that has two actions:

   - The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first `Updates:Action` should be `DELETE` and `Updates:ActivatedRule:RuleId` should be the rule group that contains the rules that you want to exclude.

   - The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second `Updates:Action` should be `INSERT`, `Updates:ActivatedRule:RuleId` should be the rule group that you just removed, and `ExcludedRules` should contain the rules that you want to exclude.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The `ActivatedRule` object in an UpdateWebACL request specifies a `Rule` that you want to insert or delete, the priority of the `Rule` in the `WebACL`, and the action that you want AWS WAF to take when a web request matches the `Rule` (`ALLOW`, `BLOCK`, or `COUNT`).

To specify whether to insert or delete a `Rule`, use the `Action` parameter in the WebACLUpdate data type.

" }, "ActivatedRules":{ "type":"list", "member":{"shape":"ActivatedRule"} }, "AssociateWebACLRequest":{ "type":"structure", "required":[ "WebACLId", "ResourceArn" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

A unique identifier (ID) for the web ACL.

" }, "ResourceArn":{ "shape":"ResourceArn", "documentation":"

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`

" } } }, "AssociateWebACLResponse":{ "type":"structure", "members":{ } }, "ByteMatchSet":{ "type":"structure", "required":[ "ByteMatchSetId", "ByteMatchTuples" ], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The `ByteMatchSetId` for a `ByteMatchSet`. You use `ByteMatchSetId` to get information about a `ByteMatchSet` (see GetByteMatchSet), update a `ByteMatchSet` (see UpdateByteMatchSet), insert a `ByteMatchSet` into a `Rule` or delete one from a `Rule` (see UpdateRule), and delete a `ByteMatchSet` from AWS WAF (see DeleteByteMatchSet).

`ByteMatchSetId` is returned by CreateByteMatchSet and by ListByteMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the ByteMatchSet. You can't change `Name` after you create a `ByteMatchSet`.

" }, "ByteMatchTuples":{ "shape":"ByteMatchTuples", "documentation":"

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In a GetByteMatchSet request, `ByteMatchSet` is a complex type that contains the `ByteMatchSetId` and `Name` of a `ByteMatchSet`, and the values that you specified when you updated the `ByteMatchSet`.

A complex type that contains `ByteMatchTuple` objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a `ByteMatchSet` contains more than one `ByteMatchTuple` object, a request needs to match the settings in only one `ByteMatchTuple` to be considered a match.

" }, "ByteMatchSetSummaries":{ "type":"list", "member":{"shape":"ByteMatchSetSummary"} }, "ByteMatchSetSummary":{ "type":"structure", "required":[ "ByteMatchSetId", "Name" ], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The `ByteMatchSetId` for a `ByteMatchSet`. You use `ByteMatchSetId` to get information about a `ByteMatchSet`, update a `ByteMatchSet`, remove a `ByteMatchSet` from a `Rule`, and delete a `ByteMatchSet` from AWS WAF.

`ByteMatchSetId` is returned by CreateByteMatchSet and by ListByteMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the ByteMatchSet. You can't change `Name` after you create a `ByteMatchSet`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returned by ListByteMatchSets. Each `ByteMatchSetSummary` object includes the `Name` and `ByteMatchSetId` for one ByteMatchSet.

" }, "ByteMatchSetUpdate":{ "type":"structure", "required":[ "Action", "ByteMatchTuple" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specifies whether to insert or delete a ByteMatchTuple.

" }, "ByteMatchTuple":{ "shape":"ByteMatchTuple", "documentation":"

Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify `DELETE` for the value of `Action`, the `ByteMatchTuple` values must exactly match the values in the `ByteMatchTuple` that you want to delete from the `ByteMatchSet`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In an UpdateByteMatchSet request, `ByteMatchSetUpdate` specifies whether to insert or delete a ByteMatchTuple and includes the settings for the `ByteMatchTuple`.

" }, "ByteMatchSetUpdates":{ "type":"list", "member":{"shape":"ByteMatchSetUpdate"}, "min":1 }, "ByteMatchTargetString":{"type":"blob"}, "ByteMatchTuple":{ "type":"structure", "required":[ "FieldToMatch", "TargetString", "TextTransformation", "PositionalConstraint" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.

" }, "TargetString":{ "shape":"ByteMatchTargetString", "documentation":"

The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in `FieldToMatch`. The maximum length of the value is 50 bytes.

Valid values depend on the values that you specified for `FieldToMatch`:

- `HEADER`: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the `User-Agent` or `Referer` header.

- `METHOD`: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, and `PUT`.

- `QUERY_STRING`: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a `?` character.

- `URI`: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, `/images/daily-ad.jpg`.

- `BODY`: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first `8192` bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

- `SINGLE_QUERY_ARG`: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for `SINGLE_QUERY_ARG` is 30 characters.

- `ALL_QUERY_ARGS`: Similar to `SINGLE_QUERY_ARG`, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in `TargetString`.

If `TargetString` includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

If you're using the AWS WAF API

Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

For example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`. If you want to search the `User-Agent` header for the value `BadBot`, you base64-encode `BadBot` using MIME base64-encoding and include the resulting value, `QmFkQm90`, in the value of `TargetString`.

If you're using the AWS CLI or one of the AWS SDKs

The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on `FieldToMatch` before inspecting it for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

- Delete the following characters: \\ \" ' ^

- Delete spaces before the following characters: / (

- Replace the following characters with a space: , ;

- Replace multiple spaces with one space

- Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

- \\f, formfeed, decimal 12

- \\t, tab, decimal 9

- \\n, newline, decimal 10

- \\r, carriage return, decimal 13

- \\v, vertical tab, decimal 11

- non-breaking space, decimal 160

`COMPRESS_WHITE_SPACE` also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. `HTML_ENTITY_DECODE` performs the following operations:

- Replaces `(ampersand)quot;` with `\"`

- Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160

- Replaces `(ampersand)lt;` with a \"less than\" symbol

- Replaces `(ampersand)gt;` with `>`

- Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding characters

- Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify `NONE` if you don't want to perform any text transformations.

" }, "PositionalConstraint":{ "shape":"PositionalConstraint", "documentation":"

Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

CONTAINS

The specified part of the web request must include the value of `TargetString`, but the location doesn't matter.

CONTAINS_WORD

The specified part of the web request must include the value of `TargetString`, and `TargetString` must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, `TargetString` must be a word, which means one of the following:

- `TargetString` exactly matches the value of the specified part of the web request, such as the value of a header.

- `TargetString` is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, `BadBot;`.

- `TargetString` is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, `;BadBot`.

- `TargetString` is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, `-BadBot;`.

EXACTLY

The value of the specified part of the web request must exactly match the value of `TargetString`.

STARTS_WITH

The value of `TargetString` must appear at the beginning of the specified part of the web request.

ENDS_WITH

The value of `TargetString` must appear at the end of the specified part of the web request.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

" }, "ByteMatchTuples":{ "type":"list", "member":{"shape":"ByteMatchTuple"} }, "ChangeAction":{ "type":"string", "enum":[ "INSERT", "DELETE" ] }, "ChangeToken":{ "type":"string", "max":128, "min":1, "pattern":".*\\S.*" }, "ChangeTokenStatus":{ "type":"string", "enum":[ "PROVISIONED", "PENDING", "INSYNC" ] }, "ComparisonOperator":{ "type":"string", "enum":[ "EQ", "NE", "LE", "LT", "GE", "GT" ] }, "Country":{"type":"string"}, "CreateByteMatchSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the ByteMatchSet. You can't change `Name` after you create a `ByteMatchSet`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateByteMatchSetResponse":{ "type":"structure", "members":{ "ByteMatchSet":{ "shape":"ByteMatchSet", "documentation":"

A ByteMatchSet that contains no `ByteMatchTuple` objects.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "CreateGeoMatchSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the GeoMatchSet. You can't change `Name` after you create the `GeoMatchSet`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateGeoMatchSetResponse":{ "type":"structure", "members":{ "GeoMatchSet":{ "shape":"GeoMatchSet", "documentation":"

The GeoMatchSet returned in the `CreateGeoMatchSet` response. The `GeoMatchSet` contains no `GeoMatchConstraints`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "CreateIPSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the IPSet. You can't change `Name` after you create the `IPSet`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateIPSetResponse":{ "type":"structure", "members":{ "IPSet":{ "shape":"IPSet", "documentation":"

The IPSet returned in the `CreateIPSet` response.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "CreateRateBasedRuleRequest":{ "type":"structure", "required":[ "Name", "MetricName", "RateKey", "RateLimit", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the RateBasedRule. You can't change the name of a `RateBasedRule` after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

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_Action.\" You can't change the name of the metric after you create the `RateBasedRule`.

" }, "RateKey":{ "shape":"RateKey", "documentation":"

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`.

" }, "RateLimit":{ "shape":"RateLimit", "documentation":"

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.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" }, "Tags":{ "shape":"TagList", "documentation":"

" } } }, "CreateRateBasedRuleResponse":{ "type":"structure", "members":{ "Rule":{ "shape":"RateBasedRule", "documentation":"

The RateBasedRule that is returned in the `CreateRateBasedRule` response.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "CreateRegexMatchSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the RegexMatchSet. You can't change `Name` after you create a `RegexMatchSet`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateRegexMatchSetResponse":{ "type":"structure", "members":{ "RegexMatchSet":{ "shape":"RegexMatchSet", "documentation":"

A RegexMatchSet that contains no `RegexMatchTuple` objects.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "CreateRegexPatternSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the RegexPatternSet. You can't change `Name` after you create a `RegexPatternSet`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateRegexPatternSetResponse":{ "type":"structure", "members":{ "RegexPatternSet":{ "shape":"RegexPatternSet", "documentation":"

A RegexPatternSet that contains no objects.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "CreateRuleGroupRequest":{ "type":"structure", "required":[ "Name", "MetricName", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the RuleGroup. You can't change `Name` after you create a `RuleGroup`.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

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_Action.\" You can't change the name of the metric after you create the `RuleGroup`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Tags":{ "shape":"TagList", "documentation":"

" } } }, "CreateRuleGroupResponse":{ "type":"structure", "members":{ "RuleGroup":{ "shape":"RuleGroup", "documentation":"

An empty RuleGroup.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "CreateRuleRequest":{ "type":"structure", "required":[ "Name", "MetricName", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the Rule. You can't change the name of a `Rule` after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

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_Action.\" You can't change the name of the metric after you create the `Rule`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Tags":{ "shape":"TagList", "documentation":"

" } } }, "CreateRuleResponse":{ "type":"structure", "members":{ "Rule":{ "shape":"Rule", "documentation":"

The Rule returned in the `CreateRule` response.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "CreateSizeConstraintSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the SizeConstraintSet. You can't change `Name` after you create a `SizeConstraintSet`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateSizeConstraintSetResponse":{ "type":"structure", "members":{ "SizeConstraintSet":{ "shape":"SizeConstraintSet", "documentation":"

A SizeConstraintSet that contains no `SizeConstraint` objects.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "CreateSqlInjectionMatchSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change `Name` after you create the `SqlInjectionMatchSet`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } }, "documentation":"

A request to create a SqlInjectionMatchSet.

" }, "CreateSqlInjectionMatchSetResponse":{ "type":"structure", "members":{ "SqlInjectionMatchSet":{ "shape":"SqlInjectionMatchSet", "documentation":"

A SqlInjectionMatchSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } }, "documentation":"

The response to a `CreateSqlInjectionMatchSet` request.

" }, "CreateWebACLMigrationStackRequest":{ "type":"structure", "required":[ "WebACLId", "S3BucketName", "IgnoreUnsupportedType" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.

" }, "S3BucketName":{ "shape":"S3BucketName", "documentation":"

The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 bucket must be configured as follows for the migration:

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

" }, "IgnoreUnsupportedType":{ "shape":"IgnoreUnsupportedType", "documentation":"

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.

" } } }, "CreateWebACLMigrationStackResponse":{ "type":"structure", "required":["S3ObjectUrl"], "members":{ "S3ObjectUrl":{ "shape":"S3ObjectUrl", "documentation":"

The URL of the template created in Amazon S3.

" } } }, "CreateWebACLRequest":{ "type":"structure", "required":[ "Name", "MetricName", "DefaultAction", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the WebACL. You can't change `Name` after you create the `WebACL`.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

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_Action.\" You can't change `MetricName` after you create the `WebACL`.

" }, "DefaultAction":{ "shape":"WafAction", "documentation":"

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`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Tags":{ "shape":"TagList", "documentation":"

" } } }, "CreateWebACLResponse":{ "type":"structure", "members":{ "WebACL":{ "shape":"WebACL", "documentation":"

The WebACL returned in the `CreateWebACL` response.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "CreateXssMatchSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description for the XssMatchSet that you're creating. You can't change `Name` after you create the `XssMatchSet`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } }, "documentation":"

A request to create an XssMatchSet.

" }, "CreateXssMatchSetResponse":{ "type":"structure", "members":{ "XssMatchSet":{ "shape":"XssMatchSet", "documentation":"

An XssMatchSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } }, "documentation":"

The response to a `CreateXssMatchSet` request.

" }, "DeleteByteMatchSetRequest":{ "type":"structure", "required":[ "ByteMatchSetId", "ChangeToken" ], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The `ByteMatchSetId` of the ByteMatchSet that you want to delete. `ByteMatchSetId` is returned by CreateByteMatchSet and by ListByteMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteByteMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "DeleteGeoMatchSetRequest":{ "type":"structure", "required":[ "GeoMatchSetId", "ChangeToken" ], "members":{ "GeoMatchSetId":{ "shape":"ResourceId", "documentation":"

The `GeoMatchSetID` of the GeoMatchSet that you want to delete. `GeoMatchSetId` is returned by CreateGeoMatchSet and by ListGeoMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteGeoMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "DeleteIPSetRequest":{ "type":"structure", "required":[ "IPSetId", "ChangeToken" ], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The `IPSetId` of the IPSet that you want to delete. `IPSetId` is returned by CreateIPSet and by ListIPSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteIPSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "DeleteLoggingConfigurationRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.

" } } }, "DeleteLoggingConfigurationResponse":{ "type":"structure", "members":{ } }, "DeletePermissionPolicyRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

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.

" } } }, "DeletePermissionPolicyResponse":{ "type":"structure", "members":{ } }, "DeleteRateBasedRuleRequest":{ "type":"structure", "required":[ "RuleId", "ChangeToken" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The `RuleId` of the RateBasedRule that you want to delete. `RuleId` is returned by CreateRateBasedRule and by ListRateBasedRules.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteRateBasedRuleResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "DeleteRegexMatchSetRequest":{ "type":"structure", "required":[ "RegexMatchSetId", "ChangeToken" ], "members":{ "RegexMatchSetId":{ "shape":"ResourceId", "documentation":"

The `RegexMatchSetId` of the RegexMatchSet that you want to delete. `RegexMatchSetId` is returned by CreateRegexMatchSet and by ListRegexMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteRegexMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "DeleteRegexPatternSetRequest":{ "type":"structure", "required":[ "RegexPatternSetId", "ChangeToken" ], "members":{ "RegexPatternSetId":{ "shape":"ResourceId", "documentation":"

The `RegexPatternSetId` of the RegexPatternSet that you want to delete. `RegexPatternSetId` is returned by CreateRegexPatternSet and by ListRegexPatternSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteRegexPatternSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "DeleteRuleGroupRequest":{ "type":"structure", "required":[ "RuleGroupId", "ChangeToken" ], "members":{ "RuleGroupId":{ "shape":"ResourceId", "documentation":"

The `RuleGroupId` of the RuleGroup that you want to delete. `RuleGroupId` is returned by CreateRuleGroup and by ListRuleGroups.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteRuleGroupResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "DeleteRuleRequest":{ "type":"structure", "required":[ "RuleId", "ChangeToken" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The `RuleId` of the Rule that you want to delete. `RuleId` is returned by CreateRule and by ListRules.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteRuleResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "DeleteSizeConstraintSetRequest":{ "type":"structure", "required":[ "SizeConstraintSetId", "ChangeToken" ], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

The `SizeConstraintSetId` of the SizeConstraintSet that you want to delete. `SizeConstraintSetId` is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteSizeConstraintSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "DeleteSqlInjectionMatchSetRequest":{ "type":"structure", "required":[ "SqlInjectionMatchSetId", "ChangeToken" ], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

The `SqlInjectionMatchSetId` of the SqlInjectionMatchSet that you want to delete. `SqlInjectionMatchSetId` is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } }, "documentation":"

A request to delete a SqlInjectionMatchSet from AWS WAF.

" }, "DeleteSqlInjectionMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } }, "documentation":"

The response to a request to delete a SqlInjectionMatchSet from AWS WAF.

" }, "DeleteWebACLRequest":{ "type":"structure", "required":[ "WebACLId", "ChangeToken" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

The `WebACLId` of the WebACL that you want to delete. `WebACLId` is returned by CreateWebACL and by ListWebACLs.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteWebACLResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "DeleteXssMatchSetRequest":{ "type":"structure", "required":[ "XssMatchSetId", "ChangeToken" ], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

The `XssMatchSetId` of the XssMatchSet that you want to delete. `XssMatchSetId` is returned by CreateXssMatchSet and by ListXssMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } }, "documentation":"

A request to delete an XssMatchSet from AWS WAF.

" }, "DeleteXssMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } }, "documentation":"

The response to a request to delete an XssMatchSet from AWS WAF.

" }, "DisassociateWebACLRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

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`

" } } }, "DisassociateWebACLResponse":{ "type":"structure", "members":{ } }, "ErrorReason":{"type":"string"}, "ExcludedRule":{ "type":"structure", "required":["RuleId"], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The unique identifier for the rule to exclude from the rule group.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The rule to exclude from a rule group. This is applicable only when the `ActivatedRule` refers to a `RuleGroup`. The rule must belong to the `RuleGroup` that is specified by the `ActivatedRule`.

" }, "ExcludedRules":{ "type":"list", "member":{"shape":"ExcludedRule"} }, "FieldToMatch":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"MatchFieldType", "documentation":"

The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

- `HEADER`: A specified request header, for example, the value of the `User-Agent` or `Referer` header. If you choose `HEADER` for the type, specify the name of the header in `Data`.

- `METHOD`: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, and `PUT`.

- `QUERY_STRING`: A query string, which is the part of a URL that appears after a `?` character, if any.

- `URI`: The part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`.

- `BODY`: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first `8192` bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

- `SINGLE_QUERY_ARG`: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for `SINGLE_QUERY_ARG` is 30 characters.

- `ALL_QUERY_ARGS`: Similar to `SINGLE_QUERY_ARG`, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in `TargetString`.

" }, "Data":{ "shape":"MatchFieldData", "documentation":"

When the value of `Type` is `HEADER`, enter the name of the header that you want AWS WAF to search, for example, `User-Agent` or `Referer`. The name of the header is not case sensitive.

When the value of `Type` is `SINGLE_QUERY_ARG`, enter the name of the parameter that you want AWS WAF to search, for example, `UserName` or `SalesRegion`. The parameter name is not case sensitive.

If the value of `Type` is any other value, omit `Data`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies where in a web request to look for `TargetString`.

" }, "GeoMatchConstraint":{ "type":"structure", "required":[ "Type", "Value" ], "members":{ "Type":{ "shape":"GeoMatchConstraintType", "documentation":"

The type of geographical area you want AWS WAF to search for. Currently `Country` is the only valid value.

" }, "Value":{ "shape":"GeoMatchConstraintValue", "documentation":"

The country that you want AWS WAF to search for.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The country from which web requests originate that you want AWS WAF to search for.

" }, "GeoMatchConstraintType":{ "type":"string", "enum":["Country"] }, "GeoMatchConstraintValue":{ "type":"string", "enum":[ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "GeoMatchConstraints":{ "type":"list", "member":{"shape":"GeoMatchConstraint"} }, "GeoMatchSet":{ "type":"structure", "required":[ "GeoMatchSetId", "GeoMatchConstraints" ], "members":{ "GeoMatchSetId":{ "shape":"ResourceId", "documentation":"

The `GeoMatchSetId` for an `GeoMatchSet`. You use `GeoMatchSetId` to get information about a `GeoMatchSet` (see GeoMatchSet), update a `GeoMatchSet` (see UpdateGeoMatchSet), insert a `GeoMatchSet` into a `Rule` or delete one from a `Rule` (see UpdateRule), and delete a `GeoMatchSet` from AWS WAF (see DeleteGeoMatchSet).

`GeoMatchSetId` is returned by CreateGeoMatchSet and by ListGeoMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the GeoMatchSet. You can't change the name of an `GeoMatchSet` after you create it.

" }, "GeoMatchConstraints":{ "shape":"GeoMatchConstraints", "documentation":"

An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains one or more countries that AWS WAF will search for.

" }, "GeoMatchSetSummaries":{ "type":"list", "member":{"shape":"GeoMatchSetSummary"} }, "GeoMatchSetSummary":{ "type":"structure", "required":[ "GeoMatchSetId", "Name" ], "members":{ "GeoMatchSetId":{ "shape":"ResourceId", "documentation":"

The `GeoMatchSetId` for an GeoMatchSet. You can use `GeoMatchSetId` in a GetGeoMatchSet request to get detailed information about an GeoMatchSet.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the GeoMatchSet. You can't change the name of an `GeoMatchSet` after you create it.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the name of the `GeoMatchSet`.

" }, "GeoMatchSetUpdate":{ "type":"structure", "required":[ "Action", "GeoMatchConstraint" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specifies whether to insert or delete a country with UpdateGeoMatchSet.

" }, "GeoMatchConstraint":{ "shape":"GeoMatchConstraint", "documentation":"

The country from which web requests originate that you want AWS WAF to search for.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the type of update to perform to an GeoMatchSet with UpdateGeoMatchSet.

" }, "GeoMatchSetUpdates":{ "type":"list", "member":{"shape":"GeoMatchSetUpdate"}, "min":1 }, "GetByteMatchSetRequest":{ "type":"structure", "required":["ByteMatchSetId"], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The `ByteMatchSetId` of the ByteMatchSet that you want to get. `ByteMatchSetId` is returned by CreateByteMatchSet and by ListByteMatchSets.

" } } }, "GetByteMatchSetResponse":{ "type":"structure", "members":{ "ByteMatchSet":{ "shape":"ByteMatchSet", "documentation":"

Information about the ByteMatchSet that you specified in the `GetByteMatchSet` request. For more information, see the following topics:

- ByteMatchSet: Contains `ByteMatchSetId`, `ByteMatchTuples`, and `Name`

- `ByteMatchTuples`: Contains an array of ByteMatchTuple objects. Each `ByteMatchTuple` object contains FieldToMatch, `PositionalConstraint`, `TargetString`, and `TextTransformation`

- FieldToMatch: Contains `Data` and `Type`

" } } }, "GetChangeTokenRequest":{ "type":"structure", "members":{ } }, "GetChangeTokenResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The `ChangeToken` that you used in the request. Use this value in a `GetChangeTokenStatus` request to get the current status of the request.

" } } }, "GetChangeTokenStatusRequest":{ "type":"structure", "required":["ChangeToken"], "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The change token for which you want to get the status. This change token was previously returned in the `GetChangeToken` response.

" } } }, "GetChangeTokenStatusResponse":{ "type":"structure", "members":{ "ChangeTokenStatus":{ "shape":"ChangeTokenStatus", "documentation":"

The status of the change token.

" } } }, "GetGeoMatchSetRequest":{ "type":"structure", "required":["GeoMatchSetId"], "members":{ "GeoMatchSetId":{ "shape":"ResourceId", "documentation":"

The `GeoMatchSetId` of the GeoMatchSet that you want to get. `GeoMatchSetId` is returned by CreateGeoMatchSet and by ListGeoMatchSets.

" } } }, "GetGeoMatchSetResponse":{ "type":"structure", "members":{ "GeoMatchSet":{ "shape":"GeoMatchSet", "documentation":"

Information about the GeoMatchSet that you specified in the `GetGeoMatchSet` request. This includes the `Type`, which for a `GeoMatchContraint` is always `Country`, as well as the `Value`, which is the identifier for a specific country.

" } } }, "GetIPSetRequest":{ "type":"structure", "required":["IPSetId"], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The `IPSetId` of the IPSet that you want to get. `IPSetId` is returned by CreateIPSet and by ListIPSets.

" } } }, "GetIPSetResponse":{ "type":"structure", "members":{ "IPSet":{ "shape":"IPSet", "documentation":"

Information about the IPSet that you specified in the `GetIPSet` request. For more information, see the following topics:

- IPSet: Contains `IPSetDescriptors`, `IPSetId`, and `Name`

- `IPSetDescriptors`: Contains an array of IPSetDescriptor objects. Each `IPSetDescriptor` object contains `Type` and `Value`

" } } }, "GetLoggingConfigurationRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

" } } }, "GetLoggingConfigurationResponse":{ "type":"structure", "members":{ "LoggingConfiguration":{ "shape":"LoggingConfiguration", "documentation":"

The LoggingConfiguration for the specified web ACL.

" } } }, "GetPermissionPolicyRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy.

" } } }, "GetPermissionPolicyResponse":{ "type":"structure", "members":{ "Policy":{ "shape":"PolicyString", "documentation":"

The IAM policy attached to the specified RuleGroup.

" } } }, "GetRateBasedRuleManagedKeysRequest":{ "type":"structure", "required":["RuleId"], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The `RuleId` of the RateBasedRule for which you want to get a list of `ManagedKeys`. `RuleId` is returned by CreateRateBasedRule and by ListRateBasedRules.

" }, "NextMarker":{ "shape":"NextMarker", "documentation":"

A null value and not currently used. Do not include this in your request.

" } } }, "GetRateBasedRuleManagedKeysResponse":{ "type":"structure", "members":{ "ManagedKeys":{ "shape":"ManagedKeys", "documentation":"

An array of IP addresses that currently are blocked by the specified RateBasedRule.

" }, "NextMarker":{ "shape":"NextMarker", "documentation":"

A null value and not currently used.

" } } }, "GetRateBasedRuleRequest":{ "type":"structure", "required":["RuleId"], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The `RuleId` of the RateBasedRule that you want to get. `RuleId` is returned by CreateRateBasedRule and by ListRateBasedRules.

" } } }, "GetRateBasedRuleResponse":{ "type":"structure", "members":{ "Rule":{ "shape":"RateBasedRule", "documentation":"

Information about the RateBasedRule that you specified in the `GetRateBasedRule` request.

" } } }, "GetRegexMatchSetRequest":{ "type":"structure", "required":["RegexMatchSetId"], "members":{ "RegexMatchSetId":{ "shape":"ResourceId", "documentation":"

The `RegexMatchSetId` of the RegexMatchSet that you want to get. `RegexMatchSetId` is returned by CreateRegexMatchSet and by ListRegexMatchSets.

" } } }, "GetRegexMatchSetResponse":{ "type":"structure", "members":{ "RegexMatchSet":{ "shape":"RegexMatchSet", "documentation":"

Information about the RegexMatchSet that you specified in the `GetRegexMatchSet` request. For more information, see RegexMatchTuple.

" } } }, "GetRegexPatternSetRequest":{ "type":"structure", "required":["RegexPatternSetId"], "members":{ "RegexPatternSetId":{ "shape":"ResourceId", "documentation":"

The `RegexPatternSetId` of the RegexPatternSet that you want to get. `RegexPatternSetId` is returned by CreateRegexPatternSet and by ListRegexPatternSets.

" } } }, "GetRegexPatternSetResponse":{ "type":"structure", "members":{ "RegexPatternSet":{ "shape":"RegexPatternSet", "documentation":"

Information about the RegexPatternSet 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.

" } } }, "GetRuleGroupRequest":{ "type":"structure", "required":["RuleGroupId"], "members":{ "RuleGroupId":{ "shape":"ResourceId", "documentation":"

The `RuleGroupId` of the RuleGroup that you want to get. `RuleGroupId` is returned by CreateRuleGroup and by ListRuleGroups.

" } } }, "GetRuleGroupResponse":{ "type":"structure", "members":{ "RuleGroup":{ "shape":"RuleGroup", "documentation":"

Information about the RuleGroup that you specified in the `GetRuleGroup` request.

" } } }, "GetRuleRequest":{ "type":"structure", "required":["RuleId"], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The `RuleId` of the Rule that you want to get. `RuleId` is returned by CreateRule and by ListRules.

" } } }, "GetRuleResponse":{ "type":"structure", "members":{ "Rule":{ "shape":"Rule", "documentation":"

Information about the Rule that you specified in the `GetRule` request. For more information, see the following topics:

- Rule: Contains `MetricName`, `Name`, an array of `Predicate` objects, and `RuleId`

- Predicate: Each `Predicate` object contains `DataId`, `Negated`, and `Type`

" } } }, "GetSampledRequestsMaxItems":{ "type":"long", "max":500, "min":1 }, "GetSampledRequestsRequest":{ "type":"structure", "required":[ "WebAclId", "RuleId", "TimeWindow", "MaxItems" ], "members":{ "WebAclId":{ "shape":"ResourceId", "documentation":"

The `WebACLId` of the `WebACL` for which you want `GetSampledRequests` to return a sample of requests.

" }, "RuleId":{ "shape":"ResourceId", "documentation":"

`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`.

" }, "TimeWindow":{ "shape":"TimeWindow", "documentation":"

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.

" }, "MaxItems":{ "shape":"GetSampledRequestsMaxItems", "documentation":"

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.

" } } }, "GetSampledRequestsResponse":{ "type":"structure", "members":{ "SampledRequests":{ "shape":"SampledHTTPRequests", "documentation":"

A complex type that contains detailed information about each of the requests in the sample.

" }, "PopulationSize":{ "shape":"PopulationSize", "documentation":"

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.

" }, "TimeWindow":{ "shape":"TimeWindow", "documentation":"

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.

" } } }, "GetSizeConstraintSetRequest":{ "type":"structure", "required":["SizeConstraintSetId"], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

The `SizeConstraintSetId` of the SizeConstraintSet that you want to get. `SizeConstraintSetId` is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" } } }, "GetSizeConstraintSetResponse":{ "type":"structure", "members":{ "SizeConstraintSet":{ "shape":"SizeConstraintSet", "documentation":"

Information about the SizeConstraintSet that you specified in the `GetSizeConstraintSet` request. For more information, see the following topics:

- SizeConstraintSet: Contains `SizeConstraintSetId`, `SizeConstraints`, and `Name`

- `SizeConstraints`: Contains an array of SizeConstraint objects. Each `SizeConstraint` object contains FieldToMatch, `TextTransformation`, `ComparisonOperator`, and `Size`

- FieldToMatch: Contains `Data` and `Type`

" } } }, "GetSqlInjectionMatchSetRequest":{ "type":"structure", "required":["SqlInjectionMatchSetId"], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

The `SqlInjectionMatchSetId` of the SqlInjectionMatchSet that you want to get. `SqlInjectionMatchSetId` is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" } }, "documentation":"

A request to get a SqlInjectionMatchSet.

" }, "GetSqlInjectionMatchSetResponse":{ "type":"structure", "members":{ "SqlInjectionMatchSet":{ "shape":"SqlInjectionMatchSet", "documentation":"

Information about the SqlInjectionMatchSet that you specified in the `GetSqlInjectionMatchSet` request. For more information, see the following topics:

- SqlInjectionMatchSet: Contains `Name`, `SqlInjectionMatchSetId`, and an array of `SqlInjectionMatchTuple` objects

- SqlInjectionMatchTuple: Each `SqlInjectionMatchTuple` object contains `FieldToMatch` and `TextTransformation`

- FieldToMatch: Contains `Data` and `Type`

" } }, "documentation":"

The response to a GetSqlInjectionMatchSet request.

" }, "GetWebACLForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

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`

" } } }, "GetWebACLForResourceResponse":{ "type":"structure", "members":{ "WebACLSummary":{ "shape":"WebACLSummary", "documentation":"

Information about the web ACL that you specified in the `GetWebACLForResource` request. If there is no associated resource, a null WebACLSummary is returned.

" } } }, "GetWebACLRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

The `WebACLId` of the WebACL that you want to get. `WebACLId` is returned by CreateWebACL and by ListWebACLs.

" } } }, "GetWebACLResponse":{ "type":"structure", "members":{ "WebACL":{ "shape":"WebACL", "documentation":"

Information about the WebACL that you specified in the `GetWebACL` request. For more information, see the following topics:

- WebACL: Contains `DefaultAction`, `MetricName`, `Name`, an array of `Rule` objects, and `WebACLId`

- `DefaultAction` (Data type is WafAction): Contains `Type`

- `Rules`: Contains an array of `ActivatedRule` objects, which contain `Action`, `Priority`, and `RuleId`

- `Action`: Contains `Type`

" } } }, "GetXssMatchSetRequest":{ "type":"structure", "required":["XssMatchSetId"], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

The `XssMatchSetId` of the XssMatchSet that you want to get. `XssMatchSetId` is returned by CreateXssMatchSet and by ListXssMatchSets.

" } }, "documentation":"

A request to get an XssMatchSet.

" }, "GetXssMatchSetResponse":{ "type":"structure", "members":{ "XssMatchSet":{ "shape":"XssMatchSet", "documentation":"

Information about the XssMatchSet that you specified in the `GetXssMatchSet` request. For more information, see the following topics:

- XssMatchSet: Contains `Name`, `XssMatchSetId`, and an array of `XssMatchTuple` objects

- XssMatchTuple: Each `XssMatchTuple` object contains `FieldToMatch` and `TextTransformation`

- FieldToMatch: Contains `Data` and `Type`

" } }, "documentation":"

The response to a GetXssMatchSet request.

" }, "HTTPHeader":{ "type":"structure", "members":{ "Name":{ "shape":"HeaderName", "documentation":"

The name of one of the headers in the sampled web request.

" }, "Value":{ "shape":"HeaderValue", "documentation":"

The value of one of the headers in the sampled web request.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The response from a GetSampledRequests request includes an `HTTPHeader` complex type that appears as `Headers` in the response syntax. `HTTPHeader` contains the names and values of all of the headers that appear in one of the web requests that were returned by `GetSampledRequests`.

" }, "HTTPHeaders":{ "type":"list", "member":{"shape":"HTTPHeader"} }, "HTTPMethod":{"type":"string"}, "HTTPRequest":{ "type":"structure", "members":{ "ClientIP":{ "shape":"IPString", "documentation":"

The IP address that the request originated from. If the `WebACL` is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

- `c-ip`, if the viewer did not use an HTTP proxy or a load balancer to send the request

- `x-forwarded-for`, if the viewer did use an HTTP proxy or a load balancer to send the request

" }, "Country":{ "shape":"Country", "documentation":"

The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.

" }, "URI":{ "shape":"URIString", "documentation":"

The part of a web request that identifies the resource, for example, `/images/daily-ad.jpg`.

" }, "Method":{ "shape":"HTTPMethod", "documentation":"

The HTTP method specified in the sampled web request. CloudFront supports the following methods: `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, and `PUT`.

" }, "HTTPVersion":{ "shape":"HTTPVersion", "documentation":"

The HTTP version specified in the sampled web request, for example, `HTTP/1.1`.

" }, "Headers":{ "shape":"HTTPHeaders", "documentation":"

A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The response from a GetSampledRequests request includes an `HTTPRequest` complex type that appears as `Request` in the response syntax. `HTTPRequest` contains information about one of the web requests that were returned by `GetSampledRequests`.

" }, "HTTPVersion":{"type":"string"}, "HeaderName":{"type":"string"}, "HeaderValue":{"type":"string"}, "IPSet":{ "type":"structure", "required":[ "IPSetId", "IPSetDescriptors" ], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The `IPSetId` for an `IPSet`. You use `IPSetId` to get information about an `IPSet` (see GetIPSet), update an `IPSet` (see UpdateIPSet), insert an `IPSet` into a `Rule` or delete one from a `Rule` (see UpdateRule), and delete an `IPSet` from AWS WAF (see DeleteIPSet).

`IPSetId` is returned by CreateIPSet and by ListIPSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the IPSet. You can't change the name of an `IPSet` after you create it.

" }, "IPSetDescriptors":{ "shape":"IPSetDescriptors", "documentation":"

The IP address type (`IPV4` or `IPV6`) and the IP address range (in CIDR notation) that web requests originate from. If the `WebACL` is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. 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.

To specify an individual IP address, you specify the four-part IP address followed by a `/32`, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

" }, "IPSetDescriptor":{ "type":"structure", "required":[ "Type", "Value" ], "members":{ "Type":{ "shape":"IPSetDescriptorType", "documentation":"

Specify `IPV4` or `IPV6`.

" }, "Value":{ "shape":"IPSetDescriptorValue", "documentation":"

Specify an IPv4 address by using CIDR notation. For example:

- To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify `192.0.2.44/32`.

- To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24`.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Specify an IPv6 address by using CIDR notation. For example:

- To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`.

- To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the IP address type (`IPV4` or `IPV6`) and the IP address range (in CIDR format) that web requests originate from.

" }, "IPSetDescriptorType":{ "type":"string", "enum":[ "IPV4", "IPV6" ] }, "IPSetDescriptorValue":{ "type":"string", "max":50, "min":1, "pattern":".*\\S.*" }, "IPSetDescriptors":{ "type":"list", "member":{"shape":"IPSetDescriptor"} }, "IPSetSummaries":{ "type":"list", "member":{"shape":"IPSetSummary"} }, "IPSetSummary":{ "type":"structure", "required":[ "IPSetId", "Name" ], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The `IPSetId` for an IPSet. You can use `IPSetId` in a GetIPSet request to get detailed information about an IPSet.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the IPSet. You can't change the name of an `IPSet` after you create it.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the name of the `IPSet`.

" }, "IPSetUpdate":{ "type":"structure", "required":[ "Action", "IPSetDescriptor" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specifies whether to insert or delete an IP address with UpdateIPSet.

" }, "IPSetDescriptor":{ "shape":"IPSetDescriptor", "documentation":"

The IP address type (`IPV4` or `IPV6`) and the IP address range (in CIDR notation) that web requests originate from.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the type of update to perform to an IPSet with UpdateIPSet.

" }, "IPSetUpdates":{ "type":"list", "member":{"shape":"IPSetUpdate"}, "min":1 }, "IPString":{"type":"string"}, "IgnoreUnsupportedType":{"type":"boolean"}, "ListActivatedRulesInRuleGroupRequest":{ "type":"structure", "members":{ "RuleGroupId":{ "shape":"ResourceId", "documentation":"

The `RuleGroupId` of the RuleGroup for which you want to get a list of ActivatedRule objects.

" }, "NextMarker":{ "shape":"NextMarker", "documentation":"

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`.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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`.

" } } }, "ListActivatedRulesInRuleGroupResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "ActivatedRules":{ "shape":"ActivatedRules", "documentation":"

An array of `ActivatedRules` objects.

" } } }, "ListByteMatchSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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`.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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.

" } } }, "ListByteMatchSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "ByteMatchSets":{ "shape":"ByteMatchSetSummaries", "documentation":"

An array of ByteMatchSetSummary objects.

" } } }, "ListGeoMatchSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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.

" } } }, "ListGeoMatchSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "GeoMatchSets":{ "shape":"GeoMatchSetSummaries", "documentation":"

An array of GeoMatchSetSummary objects.

" } } }, "ListIPSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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`.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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.

" } } }, "ListIPSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

To list more `IPSet` objects, submit another `ListIPSets` request, and in the next request use the `NextMarker` response value as the `NextMarker` value.

" }, "IPSets":{ "shape":"IPSetSummaries", "documentation":"

An array of IPSetSummary objects.

" } } }, "ListLoggingConfigurationsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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`.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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`.

" } } }, "ListLoggingConfigurationsResponse":{ "type":"structure", "members":{ "LoggingConfigurations":{ "shape":"LoggingConfigurations", "documentation":"

An array of LoggingConfiguration objects.

" }, "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" } } }, "ListRateBasedRulesRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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`.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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`.

" } } }, "ListRateBasedRulesResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "Rules":{ "shape":"RuleSummaries", "documentation":"

An array of RuleSummary objects.

" } } }, "ListRegexMatchSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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.

" } } }, "ListRegexMatchSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "RegexMatchSets":{ "shape":"RegexMatchSetSummaries", "documentation":"

An array of RegexMatchSetSummary objects.

" } } }, "ListRegexPatternSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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.

" } } }, "ListRegexPatternSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "RegexPatternSets":{ "shape":"RegexPatternSetSummaries", "documentation":"

An array of RegexPatternSetSummary objects.

" } } }, "ListResourcesForWebACLRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

The unique identifier (ID) of the web ACL for which to list the associated resources.

" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The type of resource to list, either an application load balancer or Amazon API Gateway.

" } } }, "ListResourcesForWebACLResponse":{ "type":"structure", "members":{ "ResourceArns":{ "shape":"ResourceArns", "documentation":"

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.

" } } }, "ListRuleGroupsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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`.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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`.

" } } }, "ListRuleGroupsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "RuleGroups":{ "shape":"RuleGroupSummaries", "documentation":"

An array of RuleGroup objects.

" } } }, "ListRulesRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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`.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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`.

" } } }, "ListRulesResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "Rules":{ "shape":"RuleSummaries", "documentation":"

An array of RuleSummary objects.

" } } }, "ListSizeConstraintSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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`.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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.

" } } }, "ListSizeConstraintSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "SizeConstraintSets":{ "shape":"SizeConstraintSetSummaries", "documentation":"

An array of SizeConstraintSetSummary objects.

" } } }, "ListSqlInjectionMatchSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for `Limit` and you have more SqlInjectionMatchSet 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`.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of SqlInjectionMatchSet 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`.

" } }, "documentation":"

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

" }, "ListSqlInjectionMatchSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more SqlInjectionMatchSet 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.

" }, "SqlInjectionMatchSets":{ "shape":"SqlInjectionMatchSetSummaries", "documentation":"

An array of SqlInjectionMatchSetSummary objects.

" } }, "documentation":"

The response to a ListSqlInjectionMatchSets request.

" }, "ListSubscribedRuleGroupsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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.

" } } }, "ListSubscribedRuleGroupsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "RuleGroups":{ "shape":"SubscribedRuleGroupSummaries", "documentation":"

An array of RuleGroup objects.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceARN"], "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

" }, "ResourceARN":{ "shape":"ResourceArn", "documentation":"

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

" }, "TagInfoForResource":{ "shape":"TagInfoForResource", "documentation":"

" } } }, "ListWebACLsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

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.

" } } }, "ListWebACLsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

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.

" }, "WebACLs":{ "shape":"WebACLSummaries", "documentation":"

An array of WebACLSummary objects.

" } } }, "ListXssMatchSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for `Limit` and you have more XssMatchSet 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`.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of XssMatchSet 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`.

" } }, "documentation":"

A request to list the XssMatchSet objects created by the current AWS account.

" }, "ListXssMatchSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more XssMatchSet 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.

" }, "XssMatchSets":{ "shape":"XssMatchSetSummaries", "documentation":"

An array of XssMatchSetSummary objects.

" } }, "documentation":"

The response to a ListXssMatchSets request.

" }, "LogDestinationConfigs":{ "type":"list", "member":{"shape":"ResourceArn"}, "max":1, "min":1 }, "LoggingConfiguration":{ "type":"structure", "required":[ "ResourceArn", "LogDestinationConfigs" ], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of the web ACL that you want to associate with `LogDestinationConfigs`.

" }, "LogDestinationConfigs":{ "shape":"LogDestinationConfigs", "documentation":"

An array of Amazon Kinesis Data Firehose ARNs.

" }, "RedactedFields":{ "shape":"RedactedFields", "documentation":"

The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be `xxx`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The Amazon Kinesis Data Firehose, `RedactedFields` information, and the web ACL Amazon Resource Name (ARN).

" }, "LoggingConfigurations":{ "type":"list", "member":{"shape":"LoggingConfiguration"} }, "ManagedKey":{"type":"string"}, "ManagedKeys":{ "type":"list", "member":{"shape":"ManagedKey"} }, "MatchFieldData":{ "type":"string", "max":128, "min":1, "pattern":".*\\S.*" }, "MatchFieldType":{ "type":"string", "enum":[ "URI", "QUERY_STRING", "HEADER", "METHOD", "BODY", "SINGLE_QUERY_ARG", "ALL_QUERY_ARGS" ] }, "MetricName":{ "type":"string", "max":128, "min":1, "pattern":".*\\S.*" }, "MigrationErrorType":{ "type":"string", "enum":[ "ENTITY_NOT_SUPPORTED", "ENTITY_NOT_FOUND", "S3_BUCKET_NO_PERMISSION", "S3_BUCKET_NOT_ACCESSIBLE", "S3_BUCKET_NOT_FOUND", "S3_BUCKET_INVALID_REGION", "S3_INTERNAL_ERROR" ] }, "Negated":{"type":"boolean"}, "NextMarker":{ "type":"string", "max":1224, "min":1, "pattern":".*\\S.*" }, "PaginationLimit":{ "type":"integer", "max":100, "min":0 }, "ParameterExceptionField":{ "type":"string", "enum":[ "CHANGE_ACTION", "WAF_ACTION", "WAF_OVERRIDE_ACTION", "PREDICATE_TYPE", "IPSET_TYPE", "BYTE_MATCH_FIELD_TYPE", "SQL_INJECTION_MATCH_FIELD_TYPE", "BYTE_MATCH_TEXT_TRANSFORMATION", "BYTE_MATCH_POSITIONAL_CONSTRAINT", "SIZE_CONSTRAINT_COMPARISON_OPERATOR", "GEO_MATCH_LOCATION_TYPE", "GEO_MATCH_LOCATION_VALUE", "RATE_KEY", "RULE_TYPE", "NEXT_MARKER", "RESOURCE_ARN", "TAGS", "TAG_KEYS" ] }, "ParameterExceptionParameter":{ "type":"string", "min":1 }, "ParameterExceptionReason":{ "type":"string", "enum":[ "INVALID_OPTION", "ILLEGAL_COMBINATION", "ILLEGAL_ARGUMENT", "INVALID_TAG_KEY" ] }, "PolicyString":{ "type":"string", "max":395000, "min":1, "pattern":".*\\S.*" }, "PopulationSize":{"type":"long"}, "PositionalConstraint":{ "type":"string", "enum":[ "EXACTLY", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "CONTAINS_WORD" ] }, "Predicate":{ "type":"structure", "required":[ "Negated", "Type", "DataId" ], "members":{ "Negated":{ "shape":"Negated", "documentation":"

Set `Negated` to `False` if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an `IPSet` includes the IP address `192.0.2.44`, AWS WAF will allow or block requests based on that IP address.

Set `Negated` to `True` if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an `IPSet` includes the IP address `192.0.2.44`, AWS WAF will allow, block, or count requests based on all IP addresses except `192.0.2.44`.

" }, "Type":{ "shape":"PredicateType", "documentation":"

The type of predicate in a `Rule`, such as `ByteMatch` or `IPSet`.

" }, "DataId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a predicate in a `Rule`, such as `ByteMatchSetId` or `IPSetId`. The ID is returned by the corresponding `Create` or `List` command.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a `Rule` and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

" }, "PredicateType":{ "type":"string", "enum":[ "IPMatch", "ByteMatch", "SqlInjectionMatch", "GeoMatch", "SizeConstraint", "XssMatch", "RegexMatch" ] }, "Predicates":{ "type":"list", "member":{"shape":"Predicate"} }, "PutLoggingConfigurationRequest":{ "type":"structure", "required":["LoggingConfiguration"], "members":{ "LoggingConfiguration":{ "shape":"LoggingConfiguration", "documentation":"

The Amazon Kinesis 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`.

" } } }, "PutLoggingConfigurationResponse":{ "type":"structure", "members":{ "LoggingConfiguration":{ "shape":"LoggingConfiguration", "documentation":"

The LoggingConfiguration that you submitted in the request.

" } } }, "PutPermissionPolicyRequest":{ "type":"structure", "required":[ "ResourceArn", "Policy" ], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

" }, "Policy":{ "shape":"PolicyString", "documentation":"

The policy to attach to the specified RuleGroup.

" } } }, "PutPermissionPolicyResponse":{ "type":"structure", "members":{ } }, "RateBasedRule":{ "type":"structure", "required":[ "RuleId", "MatchPredicates", "RateKey", "RateLimit" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a `RateBasedRule`. You use `RuleId` to get more information about a `RateBasedRule` (see GetRateBasedRule), update a `RateBasedRule` (see UpdateRateBasedRule), insert a `RateBasedRule` into a `WebACL` or delete one from a `WebACL` (see UpdateWebACL), or delete a `RateBasedRule` from AWS WAF (see DeleteRateBasedRule).

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description for a `RateBasedRule`. You can't change the name of a `RateBasedRule` after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

A friendly name or description for the metrics for a `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_Action.\" You can't change the name of the metric after you create the `RateBasedRule`.

" }, "MatchPredicates":{ "shape":"Predicates", "documentation":"

The `Predicates` object contains one `Predicate` element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a `RateBasedRule`.

" }, "RateKey":{ "shape":"RateKey", "documentation":"

The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for `RateKey` is `IP`. `IP` indicates that requests arriving from the same IP address are subject to the `RateLimit` that is specified in the `RateBasedRule`.

" }, "RateLimit":{ "shape":"RateLimit", "documentation":"

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.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A `RateBasedRule` is identical to a regular Rule, with one addition: a `RateBasedRule` counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a `RateBasedRule` that includes the following conditions:

- The requests come from 192.0.2.44.

- They contain the value `BadBot` in the `User-Agent` header.

In the rule, you also define the rate limit as 1,000.

Requests that meet both of these conditions and exceed 1,000 requests every five minutes trigger the rule's action (block or count), which is defined in the web ACL.

" }, "RateKey":{ "type":"string", "enum":["IP"] }, "RateLimit":{ "type":"long", "max":2000000000, "min":100 }, "RedactedFields":{ "type":"list", "member":{"shape":"FieldToMatch"} }, "RegexMatchSet":{ "type":"structure", "members":{ "RegexMatchSetId":{ "shape":"ResourceId", "documentation":"

The `RegexMatchSetId` for a `RegexMatchSet`. You use `RegexMatchSetId` to get information about a `RegexMatchSet` (see GetRegexMatchSet), update a `RegexMatchSet` (see UpdateRegexMatchSet), insert a `RegexMatchSet` into a `Rule` or delete one from a `Rule` (see UpdateRule), and delete a `RegexMatchSet` from AWS WAF (see DeleteRegexMatchSet).

`RegexMatchSetId` is returned by CreateRegexMatchSet and by ListRegexMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the RegexMatchSet. You can't change `Name` after you create a `RegexMatchSet`.

" }, "RegexMatchTuples":{ "shape":"RegexMatchTuples", "documentation":"

Contains an array of RegexMatchTuple objects. Each `RegexMatchTuple` object contains:

- The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the `User-Agent` header.

- The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

- Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In a GetRegexMatchSet request, `RegexMatchSet` is a complex type that contains the `RegexMatchSetId` and `Name` of a `RegexMatchSet`, and the values that you specified when you updated the `RegexMatchSet`.

The values are contained in a `RegexMatchTuple` object, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a `RegexMatchSet` contains more than one `RegexMatchTuple` object, a request needs to match the settings in only one `ByteMatchTuple` to be considered a match.

" }, "RegexMatchSetSummaries":{ "type":"list", "member":{"shape":"RegexMatchSetSummary"} }, "RegexMatchSetSummary":{ "type":"structure", "required":[ "RegexMatchSetId", "Name" ], "members":{ "RegexMatchSetId":{ "shape":"ResourceId", "documentation":"

The `RegexMatchSetId` for a `RegexMatchSet`. You use `RegexMatchSetId` to get information about a `RegexMatchSet`, update a `RegexMatchSet`, remove a `RegexMatchSet` from a `Rule`, and delete a `RegexMatchSet` from AWS WAF.

`RegexMatchSetId` is returned by CreateRegexMatchSet and by ListRegexMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the RegexMatchSet. You can't change `Name` after you create a `RegexMatchSet`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returned by ListRegexMatchSets. Each `RegexMatchSetSummary` object includes the `Name` and `RegexMatchSetId` for one RegexMatchSet.

" }, "RegexMatchSetUpdate":{ "type":"structure", "required":[ "Action", "RegexMatchTuple" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specifies whether to insert or delete a RegexMatchTuple.

" }, "RegexMatchTuple":{ "shape":"RegexMatchTuple", "documentation":"

Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify `DELETE` for the value of `Action`, the `RegexMatchTuple` values must exactly match the values in the `RegexMatchTuple` that you want to delete from the `RegexMatchSet`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In an UpdateRegexMatchSet request, `RegexMatchSetUpdate` specifies whether to insert or delete a RegexMatchTuple and includes the settings for the `RegexMatchTuple`.

" }, "RegexMatchSetUpdates":{ "type":"list", "member":{"shape":"RegexMatchSetUpdate"}, "min":1 }, "RegexMatchTuple":{ "type":"structure", "required":[ "FieldToMatch", "TextTransformation", "RegexPatternSetId" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

Specifies where in a web request to look for the `RegexPatternSet`.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on `RegexPatternSet` before inspecting a request for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

- Delete the following characters: \\ \" ' ^

- Delete spaces before the following characters: / (

- Replace the following characters with a space: , ;

- Replace multiple spaces with one space

- Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

- \\f, formfeed, decimal 12

- \\t, tab, decimal 9

- \\n, newline, decimal 10

- \\r, carriage return, decimal 13

- \\v, vertical tab, decimal 11

- non-breaking space, decimal 160

`COMPRESS_WHITE_SPACE` also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. `HTML_ENTITY_DECODE` performs the following operations:

- Replaces `(ampersand)quot;` with `\"`

- Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160

- Replaces `(ampersand)lt;` with a \"less than\" symbol

- Replaces `(ampersand)gt;` with `>`

- Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding characters

- Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify `NONE` if you don't want to perform any text transformations.

" }, "RegexPatternSetId":{ "shape":"ResourceId", "documentation":"

The `RegexPatternSetId` for a `RegexPatternSet`. You use `RegexPatternSetId` to get information about a `RegexPatternSet` (see GetRegexPatternSet), update a `RegexPatternSet` (see UpdateRegexPatternSet), insert a `RegexPatternSet` into a `RegexMatchSet` or delete one from a `RegexMatchSet` (see UpdateRegexMatchSet), and delete an `RegexPatternSet` from AWS WAF (see DeleteRegexPatternSet).

`RegexPatternSetId` is returned by CreateRegexPatternSet and by ListRegexPatternSets.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each `RegexMatchTuple` object contains:

- The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the `User-Agent` header.

- The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

- Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

" }, "RegexMatchTuples":{ "type":"list", "member":{"shape":"RegexMatchTuple"} }, "RegexPatternSet":{ "type":"structure", "required":[ "RegexPatternSetId", "RegexPatternStrings" ], "members":{ "RegexPatternSetId":{ "shape":"ResourceId", "documentation":"

The identifier for the `RegexPatternSet`. You use `RegexPatternSetId` to get information about a `RegexPatternSet`, update a `RegexPatternSet`, remove a `RegexPatternSet` from a `RegexMatchSet`, and delete a `RegexPatternSet` from AWS WAF.

`RegexMatchSetId` is returned by CreateRegexPatternSet and by ListRegexPatternSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the RegexPatternSet. You can't change `Name` after you create a `RegexPatternSet`.

" }, "RegexPatternStrings":{ "shape":"RegexPatternStrings", "documentation":"

Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The `RegexPatternSet` specifies 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.

" }, "RegexPatternSetSummaries":{ "type":"list", "member":{"shape":"RegexPatternSetSummary"} }, "RegexPatternSetSummary":{ "type":"structure", "required":[ "RegexPatternSetId", "Name" ], "members":{ "RegexPatternSetId":{ "shape":"ResourceId", "documentation":"

The `RegexPatternSetId` for a `RegexPatternSet`. You use `RegexPatternSetId` to get information about a `RegexPatternSet`, update a `RegexPatternSet`, remove a `RegexPatternSet` from a `RegexMatchSet`, and delete a `RegexPatternSet` from AWS WAF.

`RegexPatternSetId` is returned by CreateRegexPatternSet and by ListRegexPatternSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the RegexPatternSet. You can't change `Name` after you create a `RegexPatternSet`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returned by ListRegexPatternSets. Each `RegexPatternSetSummary` object includes the `Name` and `RegexPatternSetId` for one RegexPatternSet.

" }, "RegexPatternSetUpdate":{ "type":"structure", "required":[ "Action", "RegexPatternString" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specifies whether to insert or delete a `RegexPatternString`.

" }, "RegexPatternString":{ "shape":"RegexPatternString", "documentation":"

Specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as `B[a@]dB[o0]t`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In an UpdateRegexPatternSet request, `RegexPatternSetUpdate` specifies whether to insert or delete a `RegexPatternString` and includes the settings for the `RegexPatternString`.

" }, "RegexPatternSetUpdates":{ "type":"list", "member":{"shape":"RegexPatternSetUpdate"}, "min":1 }, "RegexPatternString":{ "type":"string", "max":512, "min":1, "pattern":".*" }, "RegexPatternStrings":{ "type":"list", "member":{"shape":"RegexPatternString"}, "max":10 }, "ResourceArn":{ "type":"string", "max":1224, "min":1, "pattern":".*\\S.*" }, "ResourceArns":{ "type":"list", "member":{"shape":"ResourceArn"} }, "ResourceId":{ "type":"string", "max":128, "min":1, "pattern":".*\\S.*" }, "ResourceName":{ "type":"string", "max":128, "min":1, "pattern":".*\\S.*" }, "ResourceType":{ "type":"string", "enum":[ "APPLICATION_LOAD_BALANCER", "API_GATEWAY" ] }, "Rule":{ "type":"structure", "required":[ "RuleId", "Predicates" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a `Rule`. You use `RuleId` to get more information about a `Rule` (see GetRule), update a `Rule` (see UpdateRule), insert a `Rule` into a `WebACL` or delete a one from a `WebACL` (see UpdateWebACL), or delete a `Rule` from AWS WAF (see DeleteRule).

`RuleId` is returned by CreateRule and by ListRules.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The friendly name or description for the `Rule`. You can't change the name of a `Rule` after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

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_Action.\" You can't change `MetricName` after you create the `Rule`.

" }, "Predicates":{ "shape":"Predicates", "documentation":"

The `Predicates` object contains one `Predicate` element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a `Rule`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a `Rule` that includes the following predicates:

- An `IPSet` that causes AWS WAF to search for web requests that originate from the IP address `192.0.2.44`

- A `ByteMatchSet` that causes AWS WAF to search for web requests for which the value of the `User-Agent` header is `BadBot`.

To match the settings in this `Rule`, a request must originate from `192.0.2.44` AND include a `User-Agent` header for which the value is `BadBot`.

" }, "RuleGroup":{ "type":"structure", "required":["RuleGroupId"], "members":{ "RuleGroupId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a `RuleGroup`. You use `RuleGroupId` to get more information about a `RuleGroup` (see GetRuleGroup), update a `RuleGroup` (see UpdateRuleGroup), insert a `RuleGroup` into a `WebACL` or delete a one from a `WebACL` (see UpdateWebACL), or delete a `RuleGroup` from AWS WAF (see DeleteRuleGroup).

`RuleGroupId` is returned by CreateRuleGroup and by ListRuleGroups.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The friendly name or description for the `RuleGroup`. You can't change the name of a `RuleGroup` after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

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_Action.\" You can't change the name of the metric after you create the `RuleGroup`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A collection of predefined rules that you can add to a web ACL.

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.

" }, "RuleGroupSummaries":{ "type":"list", "member":{"shape":"RuleGroupSummary"} }, "RuleGroupSummary":{ "type":"structure", "required":[ "RuleGroupId", "Name" ], "members":{ "RuleGroupId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a `RuleGroup`. You use `RuleGroupId` to get more information about a `RuleGroup` (see GetRuleGroup), update a `RuleGroup` (see UpdateRuleGroup), insert a `RuleGroup` into a `WebACL` or delete one from a `WebACL` (see UpdateWebACL), or delete a `RuleGroup` from AWS WAF (see DeleteRuleGroup).

`RuleGroupId` is returned by CreateRuleGroup and by ListRuleGroups.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the RuleGroup. You can't change the name of a `RuleGroup` after you create it.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the friendly name or description of the `RuleGroup`.

" }, "RuleGroupUpdate":{ "type":"structure", "required":[ "Action", "ActivatedRule" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify `INSERT` to add an `ActivatedRule` to a `RuleGroup`. Use `DELETE` to remove an `ActivatedRule` from a `RuleGroup`.

" }, "ActivatedRule":{ "shape":"ActivatedRule", "documentation":"

The `ActivatedRule` object specifies a `Rule` that you want to insert or delete, the priority of the `Rule` in the `WebACL`, and the action that you want AWS WAF to take when a web request matches the `Rule` (`ALLOW`, `BLOCK`, or `COUNT`).

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies an `ActivatedRule` and indicates whether you want to add it to a `RuleGroup` or delete it from a `RuleGroup`.

" }, "RuleGroupUpdates":{ "type":"list", "member":{"shape":"RuleGroupUpdate"}, "min":1 }, "RulePriority":{"type":"integer"}, "RuleSummaries":{ "type":"list", "member":{"shape":"RuleSummary"} }, "RuleSummary":{ "type":"structure", "required":[ "RuleId", "Name" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a `Rule`. You use `RuleId` to get more information about a `Rule` (see GetRule), update a `Rule` (see UpdateRule), insert a `Rule` into a `WebACL` or delete one from a `WebACL` (see UpdateWebACL), or delete a `Rule` from AWS WAF (see DeleteRule).

`RuleId` is returned by CreateRule and by ListRules.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the Rule. You can't change the name of a `Rule` after you create it.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the friendly name or description of the `Rule`.

" }, "RuleUpdate":{ "type":"structure", "required":[ "Action", "Predicate" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify `INSERT` to add a `Predicate` to a `Rule`. Use `DELETE` to remove a `Predicate` from a `Rule`.

" }, "Predicate":{ "shape":"Predicate", "documentation":"

The ID of the `Predicate` (such as an `IPSet`) that you want to add to a `Rule`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies a `Predicate` (such as an `IPSet`) and indicates whether you want to add it to a `Rule` or delete it from a `Rule`.

" }, "RuleUpdates":{ "type":"list", "member":{"shape":"RuleUpdate"} }, "S3BucketName":{ "type":"string", "max":63, "min":3, "pattern":"^aws-waf-migration-[0-9A-Za-z\\.\\-_]*" }, "S3ObjectUrl":{ "type":"string", "min":1 }, "SampleWeight":{ "type":"long", "min":0 }, "SampledHTTPRequest":{ "type":"structure", "required":[ "Request", "Weight" ], "members":{ "Request":{ "shape":"HTTPRequest", "documentation":"

A complex type that contains detailed information about the request.

" }, "Weight":{ "shape":"SampleWeight", "documentation":"

A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of `2` represents roughly twice as many CloudFront web requests as a result that has a weight of `1`.

" }, "Timestamp":{ "shape":"Timestamp", "documentation":"

The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

" }, "Action":{ "shape":"Action", "documentation":"

The action for the `Rule` that the request matched: `ALLOW`, `BLOCK`, or `COUNT`.

" }, "RuleWithinRuleGroup":{ "shape":"ResourceId", "documentation":"

This value is returned if the `GetSampledRequests` request specifies the ID of a `RuleGroup` rather than the ID of an individual rule. `RuleWithinRuleGroup` is the rule within the specified `RuleGroup` that matched the request listed in the response.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The response from a GetSampledRequests request includes a `SampledHTTPRequests` complex type that appears as `SampledRequests` in the response syntax. `SampledHTTPRequests` contains one `SampledHTTPRequest` object for each web request that is returned by `GetSampledRequests`.

" }, "SampledHTTPRequests":{ "type":"list", "member":{"shape":"SampledHTTPRequest"} }, "Size":{ "type":"long", "max":21474836480, "min":0 }, "SizeConstraint":{ "type":"structure", "required":[ "FieldToMatch", "TextTransformation", "ComparisonOperator", "Size" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

Specifies where in a web request to look for the size constraint.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on `FieldToMatch` before inspecting it for a match.

You can only specify a single type of TextTransformation.

Note that if you choose `BODY` for the value of `Type`, you must choose `NONE` for `TextTransformation` because CloudFront forwards only the first 8192 bytes for inspection.

NONE

Specify `NONE` if you don't want to perform any text transformations.

CMD_LINE

When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

- Delete the following characters: \\ \" ' ^

- Delete spaces before the following characters: / (

- Replace the following characters with a space: , ;

- Replace multiple spaces with one space

- Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

- \\f, formfeed, decimal 12

- \\t, tab, decimal 9

- \\n, newline, decimal 10

- \\r, carriage return, decimal 13

- \\v, vertical tab, decimal 11

- non-breaking space, decimal 160

`COMPRESS_WHITE_SPACE` also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. `HTML_ENTITY_DECODE` performs the following operations:

- Replaces `(ampersand)quot;` with `\"`

- Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160

- Replaces `(ampersand)lt;` with a \"less than\" symbol

- Replaces `(ampersand)gt;` with `>`

- Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding characters

- Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

" }, "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"

The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided `Size` and `FieldToMatch` to build an expression in the form of \"`Size` `ComparisonOperator` size in bytes of `FieldToMatch`\". If that expression is true, the `SizeConstraint` is considered to match.

EQ: Used to test if the `Size` is equal to the size of the `FieldToMatch`

NE: Used to test if the `Size` is not equal to the size of the `FieldToMatch`

LE: Used to test if the `Size` is less than or equal to the size of the `FieldToMatch`

LT: Used to test if the `Size` is strictly less than the size of the `FieldToMatch`

GE: Used to test if the `Size` is greater than or equal to the size of the `FieldToMatch`

GT: Used to test if the `Size` is strictly greater than the size of the `FieldToMatch`

" }, "Size":{ "shape":"Size", "documentation":"

The size in bytes that you want AWS WAF to compare against the size of the specified `FieldToMatch`. AWS WAF uses this in combination with `ComparisonOperator` and `FieldToMatch` to build an expression in the form of \"`Size` `ComparisonOperator` size in bytes of `FieldToMatch`\". If that expression is true, the `SizeConstraint` is considered to match.

Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).

If you specify `URI` for the value of `Type`, the / in the URI counts as one character. For example, the URI `/logo.jpg` is nine characters long.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies a constraint on the size of a part of the web request. AWS WAF uses the `Size`, `ComparisonOperator`, and `FieldToMatch` to build an expression in the form of \"`Size` `ComparisonOperator` size in bytes of `FieldToMatch`\". If that expression is true, the `SizeConstraint` is considered to match.

" }, "SizeConstraintSet":{ "type":"structure", "required":[ "SizeConstraintSetId", "SizeConstraints" ], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a `SizeConstraintSet`. You use `SizeConstraintSetId` to get information about a `SizeConstraintSet` (see GetSizeConstraintSet), update a `SizeConstraintSet` (see UpdateSizeConstraintSet), insert a `SizeConstraintSet` into a `Rule` or delete one from a `Rule` (see UpdateRule), and delete a `SizeConstraintSet` from AWS WAF (see DeleteSizeConstraintSet).

`SizeConstraintSetId` is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name, if any, of the `SizeConstraintSet`.

" }, "SizeConstraints":{ "shape":"SizeConstraints", "documentation":"

Specifies the parts of web requests that you want to inspect the size of.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A complex type that contains `SizeConstraint` objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a `SizeConstraintSet` contains more than one `SizeConstraint` object, a request only needs to match one constraint to be considered a match.

" }, "SizeConstraintSetSummaries":{ "type":"list", "member":{"shape":"SizeConstraintSetSummary"} }, "SizeConstraintSetSummary":{ "type":"structure", "required":[ "SizeConstraintSetId", "Name" ], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a `SizeConstraintSet`. You use `SizeConstraintSetId` to get information about a `SizeConstraintSet` (see GetSizeConstraintSet), update a `SizeConstraintSet` (see UpdateSizeConstraintSet), insert a `SizeConstraintSet` into a `Rule` or delete one from a `Rule` (see UpdateRule), and delete a `SizeConstraintSet` from AWS WAF (see DeleteSizeConstraintSet).

`SizeConstraintSetId` is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name of the `SizeConstraintSet`, if any.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The `Id` and `Name` of a `SizeConstraintSet`.

" }, "SizeConstraintSetUpdate":{ "type":"structure", "required":[ "Action", "SizeConstraint" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify `INSERT` to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use `DELETE` to remove a `SizeConstraintSetUpdate` from a `SizeConstraintSet`.

" }, "SizeConstraint":{ "shape":"SizeConstraint", "documentation":"

Specifies a constraint on the size of a part of the web request. AWS WAF uses the `Size`, `ComparisonOperator`, and `FieldToMatch` to build an expression in the form of \"`Size` `ComparisonOperator` size in bytes of `FieldToMatch`\". If that expression is true, the `SizeConstraint` is considered to match.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want to inspect the size of and indicates whether you want to add the specification to a SizeConstraintSet or delete it from a `SizeConstraintSet`.

" }, "SizeConstraintSetUpdates":{ "type":"list", "member":{"shape":"SizeConstraintSetUpdate"}, "min":1 }, "SizeConstraints":{ "type":"list", "member":{"shape":"SizeConstraint"} }, "SqlInjectionMatchSet":{ "type":"structure", "required":[ "SqlInjectionMatchSetId", "SqlInjectionMatchTuples" ], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a `SqlInjectionMatchSet`. You use `SqlInjectionMatchSetId` to get information about a `SqlInjectionMatchSet` (see GetSqlInjectionMatchSet), update a `SqlInjectionMatchSet` (see UpdateSqlInjectionMatchSet), insert a `SqlInjectionMatchSet` into a `Rule` or delete one from a `Rule` (see UpdateRule), and delete a `SqlInjectionMatchSet` from AWS WAF (see DeleteSqlInjectionMatchSet).

`SqlInjectionMatchSetId` is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name, if any, of the `SqlInjectionMatchSet`.

" }, "SqlInjectionMatchTuples":{ "shape":"SqlInjectionMatchTuples", "documentation":"

Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A complex type that contains `SqlInjectionMatchTuple` objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a `SqlInjectionMatchSet` contains more than one `SqlInjectionMatchTuple` object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match.

" }, "SqlInjectionMatchSetSummaries":{ "type":"list", "member":{"shape":"SqlInjectionMatchSetSummary"} }, "SqlInjectionMatchSetSummary":{ "type":"structure", "required":[ "SqlInjectionMatchSetId", "Name" ], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a `SqlInjectionMatchSet`. You use `SqlInjectionMatchSetId` to get information about a `SqlInjectionMatchSet` (see GetSqlInjectionMatchSet), update a `SqlInjectionMatchSet` (see UpdateSqlInjectionMatchSet), insert a `SqlInjectionMatchSet` into a `Rule` or delete one from a `Rule` (see UpdateRule), and delete a `SqlInjectionMatchSet` from AWS WAF (see DeleteSqlInjectionMatchSet).

`SqlInjectionMatchSetId` is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name of the `SqlInjectionMatchSet`, if any, specified by `Id`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The `Id` and `Name` of a `SqlInjectionMatchSet`.

" }, "SqlInjectionMatchSetUpdate":{ "type":"structure", "required":[ "Action", "SqlInjectionMatchTuple" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify `INSERT` to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use `DELETE` to remove a `SqlInjectionMatchSetUpdate` from a `SqlInjectionMatchSet`.

" }, "SqlInjectionMatchTuple":{ "shape":"SqlInjectionMatchTuple", "documentation":"

Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the specification to a SqlInjectionMatchSet or delete it from a `SqlInjectionMatchSet`.

" }, "SqlInjectionMatchSetUpdates":{ "type":"list", "member":{"shape":"SqlInjectionMatchSetUpdate"}, "min":1 }, "SqlInjectionMatchTuple":{ "type":"structure", "required":[ "FieldToMatch", "TextTransformation" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

Specifies where in a web request to look for snippets of malicious SQL code.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on `FieldToMatch` before inspecting it for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

- Delete the following characters: \\ \" ' ^

- Delete spaces before the following characters: / (

- Replace the following characters with a space: , ;

- Replace multiple spaces with one space

- Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

- \\f, formfeed, decimal 12

- \\t, tab, decimal 9

- \\n, newline, decimal 10

- \\r, carriage return, decimal 13

- \\v, vertical tab, decimal 11

- non-breaking space, decimal 160

`COMPRESS_WHITE_SPACE` also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. `HTML_ENTITY_DECODE` performs the following operations:

- Replaces `(ampersand)quot;` with `\"`

- Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160

- Replaces `(ampersand)lt;` with a \"less than\" symbol

- Replaces `(ampersand)gt;` with `>`

- Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding characters

- Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify `NONE` if you don't want to perform any text transformations.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

" }, "SqlInjectionMatchTuples":{ "type":"list", "member":{"shape":"SqlInjectionMatchTuple"} }, "SubscribedRuleGroupSummaries":{ "type":"list", "member":{"shape":"SubscribedRuleGroupSummary"} }, "SubscribedRuleGroupSummary":{ "type":"structure", "required":[ "RuleGroupId", "Name", "MetricName" ], "members":{ "RuleGroupId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a `RuleGroup`.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the `RuleGroup`. You can't change the name of a `RuleGroup` after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

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_Action.\" You can't change the name of the metric after you create the `RuleGroup`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A summary of the rule groups you are subscribed to.

" }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

" }, "Value":{ "shape":"TagValue", "documentation":"

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A tag associated with an 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.

" }, "TagInfoForResource":{ "type":"structure", "members":{ "ResourceARN":{ "shape":"ResourceArn", "documentation":"

" }, "TagList":{ "shape":"TagList", "documentation":"

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Information for a tag associated with an 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.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":".*\\S.*" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "Tags" ], "members":{ "ResourceARN":{ "shape":"ResourceArn", "documentation":"

" }, "Tags":{ "shape":"TagList", "documentation":"

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":".*" }, "TextTransformation":{ "type":"string", "enum":[ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE" ] }, "TimeWindow":{ "type":"structure", "required":[ "StartTime", "EndTime" ], "members":{ "StartTime":{ "shape":"Timestamp", "documentation":"

The beginning of the time range from which you want `GetSampledRequests` to return a sample of the requests that your AWS resource received. You must specify the date and time 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.

" }, "EndTime":{ "shape":"Timestamp", "documentation":"

The end of the time range from which you want `GetSampledRequests` to return a sample of the requests that your AWS resource received. You must specify the date and time 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.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In a GetSampledRequests request, the `StartTime` and `EndTime` objects specify the time range for which you want AWS WAF to return a sample of web 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\"`.

In a GetSampledRequests response, the `StartTime` and `EndTime` objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, `EndTime` is the time that AWS WAF received the 5,000th request.

" }, "Timestamp":{"type":"timestamp"}, "URIString":{"type":"string"}, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "TagKeys" ], "members":{ "ResourceARN":{ "shape":"ResourceArn", "documentation":"

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateByteMatchSetRequest":{ "type":"structure", "required":[ "ByteMatchSetId", "ChangeToken", "Updates" ], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The `ByteMatchSetId` of the ByteMatchSet that you want to update. `ByteMatchSetId` is returned by CreateByteMatchSet and by ListByteMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"ByteMatchSetUpdates", "documentation":"

An array of `ByteMatchSetUpdate` objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:

- ByteMatchSetUpdate: Contains `Action` and `ByteMatchTuple`

- ByteMatchTuple: Contains `FieldToMatch`, `PositionalConstraint`, `TargetString`, and `TextTransformation`

- FieldToMatch: Contains `Data` and `Type`

" } } }, "UpdateByteMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "UpdateGeoMatchSetRequest":{ "type":"structure", "required":[ "GeoMatchSetId", "ChangeToken", "Updates" ], "members":{ "GeoMatchSetId":{ "shape":"ResourceId", "documentation":"

The `GeoMatchSetId` of the GeoMatchSet that you want to update. `GeoMatchSetId` is returned by CreateGeoMatchSet and by ListGeoMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"GeoMatchSetUpdates", "documentation":"

An array of `GeoMatchSetUpdate` objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types:

- GeoMatchSetUpdate: Contains `Action` and `GeoMatchConstraint`

- GeoMatchConstraint: 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.

" } } }, "UpdateGeoMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "UpdateIPSetRequest":{ "type":"structure", "required":[ "IPSetId", "ChangeToken", "Updates" ], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The `IPSetId` of the IPSet that you want to update. `IPSetId` is returned by CreateIPSet and by ListIPSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"IPSetUpdates", "documentation":"

An array of `IPSetUpdate` objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:

- IPSetUpdate: Contains `Action` and `IPSetDescriptor`

- IPSetDescriptor: Contains `Type` and `Value`

You can insert a maximum of 1000 addresses in a single request.

" } } }, "UpdateIPSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "UpdateRateBasedRuleRequest":{ "type":"structure", "required":[ "RuleId", "ChangeToken", "Updates", "RateLimit" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The `RuleId` of the `RateBasedRule` that you want to update. `RuleId` is returned by `CreateRateBasedRule` and by ListRateBasedRules.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"RuleUpdates", "documentation":"

An array of `RuleUpdate` objects that you want to insert into or delete from a RateBasedRule.

" }, "RateLimit":{ "shape":"RateLimit", "documentation":"

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.

" } } }, "UpdateRateBasedRuleResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "UpdateRegexMatchSetRequest":{ "type":"structure", "required":[ "RegexMatchSetId", "Updates", "ChangeToken" ], "members":{ "RegexMatchSetId":{ "shape":"ResourceId", "documentation":"

The `RegexMatchSetId` of the RegexMatchSet that you want to update. `RegexMatchSetId` is returned by CreateRegexMatchSet and by ListRegexMatchSets.

" }, "Updates":{ "shape":"RegexMatchSetUpdates", "documentation":"

An array of `RegexMatchSetUpdate` objects that you want to insert into or delete from a RegexMatchSet. For more information, see RegexMatchTuple.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "UpdateRegexMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "UpdateRegexPatternSetRequest":{ "type":"structure", "required":[ "RegexPatternSetId", "Updates", "ChangeToken" ], "members":{ "RegexPatternSetId":{ "shape":"ResourceId", "documentation":"

The `RegexPatternSetId` of the RegexPatternSet that you want to update. `RegexPatternSetId` is returned by CreateRegexPatternSet and by ListRegexPatternSets.

" }, "Updates":{ "shape":"RegexPatternSetUpdates", "documentation":"

An array of `RegexPatternSetUpdate` objects that you want to insert into or delete from a RegexPatternSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "UpdateRegexPatternSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "UpdateRuleGroupRequest":{ "type":"structure", "required":[ "RuleGroupId", "Updates", "ChangeToken" ], "members":{ "RuleGroupId":{ "shape":"ResourceId", "documentation":"

The `RuleGroupId` of the RuleGroup that you want to update. `RuleGroupId` is returned by CreateRuleGroup and by ListRuleGroups.

" }, "Updates":{ "shape":"RuleGroupUpdates", "documentation":"

An array of `RuleGroupUpdate` objects that you want to insert into or delete from a RuleGroup.

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`.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "UpdateRuleGroupResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "UpdateRuleRequest":{ "type":"structure", "required":[ "RuleId", "ChangeToken", "Updates" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The `RuleId` of the `Rule` that you want to update. `RuleId` is returned by `CreateRule` and by ListRules.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"RuleUpdates", "documentation":"

An array of `RuleUpdate` objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

- RuleUpdate: Contains `Action` and `Predicate`

- Predicate: Contains `DataId`, `Negated`, and `Type`

- FieldToMatch: Contains `Data` and `Type`

" } } }, "UpdateRuleResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "UpdateSizeConstraintSetRequest":{ "type":"structure", "required":[ "SizeConstraintSetId", "ChangeToken", "Updates" ], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

The `SizeConstraintSetId` of the SizeConstraintSet that you want to update. `SizeConstraintSetId` is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"SizeConstraintSetUpdates", "documentation":"

An array of `SizeConstraintSetUpdate` objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types:

- SizeConstraintSetUpdate: Contains `Action` and `SizeConstraint`

- SizeConstraint: Contains `FieldToMatch`, `TextTransformation`, `ComparisonOperator`, and `Size`

- FieldToMatch: Contains `Data` and `Type`

" } } }, "UpdateSizeConstraintSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "UpdateSqlInjectionMatchSetRequest":{ "type":"structure", "required":[ "SqlInjectionMatchSetId", "ChangeToken", "Updates" ], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

The `SqlInjectionMatchSetId` of the `SqlInjectionMatchSet` that you want to update. `SqlInjectionMatchSetId` is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"SqlInjectionMatchSetUpdates", "documentation":"

An array of `SqlInjectionMatchSetUpdate` objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types:

- SqlInjectionMatchSetUpdate: Contains `Action` and `SqlInjectionMatchTuple`

- SqlInjectionMatchTuple: Contains `FieldToMatch` and `TextTransformation`

- FieldToMatch: Contains `Data` and `Type`

" } }, "documentation":"

A request to update a SqlInjectionMatchSet.

" }, "UpdateSqlInjectionMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } }, "documentation":"

The response to an UpdateSqlInjectionMatchSets request.

" }, "UpdateWebACLRequest":{ "type":"structure", "required":[ "WebACLId", "ChangeToken" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

The `WebACLId` of the WebACL that you want to update. `WebACLId` is returned by CreateWebACL and by ListWebACLs.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"WebACLUpdates", "documentation":"

An array of updates to make to the WebACL.

An array of `WebACLUpdate` objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

- WebACLUpdate: Contains `Action` and `ActivatedRule`

- ActivatedRule: 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: Contains `Type`

" }, "DefaultAction":{ "shape":"WafAction", "documentation":"

A default action for the web ACL, 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 web ACL.

" } } }, "UpdateWebACLResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } } }, "UpdateXssMatchSetRequest":{ "type":"structure", "required":[ "XssMatchSetId", "ChangeToken", "Updates" ], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

The `XssMatchSetId` of the `XssMatchSet` that you want to update. `XssMatchSetId` is returned by CreateXssMatchSet and by ListXssMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"XssMatchSetUpdates", "documentation":"

An array of `XssMatchSetUpdate` objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types:

- XssMatchSetUpdate: Contains `Action` and `XssMatchTuple`

- XssMatchTuple: Contains `FieldToMatch` and `TextTransformation`

- FieldToMatch: Contains `Data` and `Type`

" } }, "documentation":"

A request to update an XssMatchSet.

" }, "UpdateXssMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

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.

" } }, "documentation":"

The response to an UpdateXssMatchSets request.

" }, "WAFBadRequestException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

", "exception":true }, "WAFDisallowedNameException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The name specified is invalid.

", "exception":true }, "WAFEntityMigrationException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"}, "MigrationErrorType":{"shape":"MigrationErrorType"}, "MigrationErrorReason":{"shape":"ErrorReason"} }, "documentation":"

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.

", "exception":true }, "WAFInternalErrorException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

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

", "exception":true, "fault":true }, "WAFInvalidAccountException":{ "type":"structure", "members":{ }, "documentation":"

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

", "exception":true }, "WAFInvalidOperationException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

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`.

", "exception":true }, "WAFInvalidParameterException":{ "type":"structure", "members":{ "field":{"shape":"ParameterExceptionField"}, "parameter":{"shape":"ParameterExceptionParameter"}, "reason":{"shape":"ParameterExceptionReason"} }, "documentation":"

The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

- You specified an invalid parameter name.

- You specified an invalid value.

- You tried to update an object (`ByteMatchSet`, `IPSet`, `Rule`, or `WebACL`) using an action other than `INSERT` or `DELETE`.

- You tried to create a `WebACL` with a `DefaultAction` `Type` other than `ALLOW`, `BLOCK`, or `COUNT`.

- You tried to create a `RateBasedRule` with a `RateKey` value other than `IP`.

- You tried to update a `WebACL` with a `WafAction` `Type` other than `ALLOW`, `BLOCK`, or `COUNT`.

- You tried to update a `ByteMatchSet` with a `FieldToMatch` `Type` other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

- You tried to update a `ByteMatchSet` with a `Field` of `HEADER` but no value for `Data`.

- Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

", "exception":true }, "WAFInvalidPermissionPolicyException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

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.

", "exception":true }, "WAFInvalidRegexPatternException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The regular expression (regex) you specified in `RegexPatternString` is invalid.

", "exception":true }, "WAFLimitsExceededException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation exceeds a resource limit, for example, the maximum number of `WebACL` objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.

", "exception":true }, "WAFNonEmptyEntityException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

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.

", "exception":true }, "WAFNonexistentContainerException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

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.

", "exception":true }, "WAFNonexistentItemException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

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

", "exception":true }, "WAFReferencedItemException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

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`.

", "exception":true }, "WAFServiceLinkedRoleErrorException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

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.

", "exception":true }, "WAFStaleDataException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

", "exception":true }, "WAFSubscriptionNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The specified subscription does not exist.

", "exception":true }, "WAFTagOperationException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

", "exception":true }, "WAFTagOperationInternalErrorException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

", "exception":true, "fault":true }, "WAFUnavailableEntityException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because the entity referenced is temporarily unavailable. Retry your request.

", "exception":true }, "WafAction":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"WafActionType", "documentation":"

Specifies how you want AWS WAF to respond to requests that match the settings in a `Rule`. Valid settings include the following:

- `ALLOW`: AWS WAF allows requests

- `BLOCK`: AWS WAF blocks requests

- `COUNT`: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify `COUNT` for the default action for a `WebACL`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

For the action that is associated with a rule in a `WebACL`, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a `WebACL`, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a `WebACL`.

" }, "WafActionType":{ "type":"string", "enum":[ "BLOCK", "ALLOW", "COUNT" ] }, "WafOverrideAction":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"WafOverrideActionType", "documentation":"

`COUNT` overrides the action specified by the individual rule within a `RuleGroup` . If set to `NONE`, the rule's action will take place.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The action to take if any rule within the `RuleGroup` matches a request.

" }, "WafOverrideActionType":{ "type":"string", "enum":[ "NONE", "COUNT" ] }, "WafRuleType":{ "type":"string", "enum":[ "REGULAR", "RATE_BASED", "GROUP" ] }, "WebACL":{ "type":"structure", "required":[ "WebACLId", "DefaultAction", "Rules" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a `WebACL`. You use `WebACLId` to get information about a `WebACL` (see GetWebACL), update a `WebACL` (see UpdateWebACL), and delete a `WebACL` from AWS WAF (see DeleteWebACL).

`WebACLId` is returned by CreateWebACL and by ListWebACLs.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the `WebACL`. You can't change the name of a `WebACL` after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

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_Action.\" You can't change `MetricName` after you create the `WebACL`.

" }, "DefaultAction":{ "shape":"WafAction", "documentation":"

The action to perform if none of the `Rules` contained in the `WebACL` match. The action is specified by the WafAction object.

" }, "Rules":{ "shape":"ActivatedRules", "documentation":"

An array that contains the action for each `Rule` in a `WebACL`, the priority of the `Rule`, and the ID of the `Rule`.

" }, "WebACLArn":{ "shape":"ResourceArn", "documentation":"

Tha Amazon Resource Name (ARN) of the web ACL.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the `Rules` that identify the requests that you want to allow, block, or count. In a `WebACL`, you also specify a default action (`ALLOW` or `BLOCK`), and the action for each `Rule` that you add to a `WebACL`, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the `WebACL` with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one `Rule` to a `WebACL`, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

" }, "WebACLSummaries":{ "type":"list", "member":{"shape":"WebACLSummary"} }, "WebACLSummary":{ "type":"structure", "required":[ "WebACLId", "Name" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a `WebACL`. You use `WebACLId` to get information about a `WebACL` (see GetWebACL), update a `WebACL` (see UpdateWebACL), and delete a `WebACL` from AWS WAF (see DeleteWebACL).

`WebACLId` is returned by CreateWebACL and by ListWebACLs.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the WebACL. You can't change the name of a `WebACL` after you create it.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the name or description of the WebACL.

" }, "WebACLUpdate":{ "type":"structure", "required":[ "Action", "ActivatedRule" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specifies whether to insert a `Rule` into or delete a `Rule` from a `WebACL`.

" }, "ActivatedRule":{ "shape":"ActivatedRule", "documentation":"

The `ActivatedRule` object in an UpdateWebACL request specifies a `Rule` that you want to insert or delete, the priority of the `Rule` in the `WebACL`, and the action that you want AWS WAF to take when a web request matches the `Rule` (`ALLOW`, `BLOCK`, or `COUNT`).

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies whether to insert a `Rule` into or delete a `Rule` from a `WebACL`.

" }, "WebACLUpdates":{ "type":"list", "member":{"shape":"WebACLUpdate"} }, "XssMatchSet":{ "type":"structure", "required":[ "XssMatchSetId", "XssMatchTuples" ], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for an `XssMatchSet`. You use `XssMatchSetId` to get information about an `XssMatchSet` (see GetXssMatchSet), update an `XssMatchSet` (see UpdateXssMatchSet), insert an `XssMatchSet` into a `Rule` or delete one from a `Rule` (see UpdateRule), and delete an `XssMatchSet` from AWS WAF (see DeleteXssMatchSet).

`XssMatchSetId` is returned by CreateXssMatchSet and by ListXssMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name, if any, of the `XssMatchSet`.

" }, "XssMatchTuples":{ "shape":"XssMatchTuples", "documentation":"

Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A complex type that contains `XssMatchTuple` objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a `XssMatchSet` contains more than one `XssMatchTuple` object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.

" }, "XssMatchSetSummaries":{ "type":"list", "member":{"shape":"XssMatchSetSummary"} }, "XssMatchSetSummary":{ "type":"structure", "required":[ "XssMatchSetId", "Name" ], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for an `XssMatchSet`. You use `XssMatchSetId` to get information about a `XssMatchSet` (see GetXssMatchSet), update an `XssMatchSet` (see UpdateXssMatchSet), insert an `XssMatchSet` into a `Rule` or delete one from a `Rule` (see UpdateRule), and delete an `XssMatchSet` from AWS WAF (see DeleteXssMatchSet).

`XssMatchSetId` is returned by CreateXssMatchSet and by ListXssMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name of the `XssMatchSet`, if any, specified by `Id`.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The `Id` and `Name` of an `XssMatchSet`.

" }, "XssMatchSetUpdate":{ "type":"structure", "required":[ "Action", "XssMatchTuple" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify `INSERT` to add an XssMatchSetUpdate to an XssMatchSet. Use `DELETE` to remove an `XssMatchSetUpdate` from an `XssMatchSet`.

" }, "XssMatchTuple":{ "shape":"XssMatchTuple", "documentation":"

Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the specification to an XssMatchSet or delete it from an `XssMatchSet`.

" }, "XssMatchSetUpdates":{ "type":"list", "member":{"shape":"XssMatchSetUpdate"}, "min":1 }, "XssMatchTuple":{ "type":"structure", "required":[ "FieldToMatch", "TextTransformation" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

Specifies where in a web request to look for cross-site scripting attacks.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on `FieldToMatch` before inspecting it for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

- Delete the following characters: \\ \" ' ^

- Delete spaces before the following characters: / (

- Replace the following characters with a space: , ;

- Replace multiple spaces with one space

- Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

- \\f, formfeed, decimal 12

- \\t, tab, decimal 9

- \\n, newline, decimal 10

- \\r, carriage return, decimal 13

- \\v, vertical tab, decimal 11

- non-breaking space, decimal 160

`COMPRESS_WHITE_SPACE` also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. `HTML_ENTITY_DECODE` performs the following operations:

- Replaces `(ampersand)quot;` with `\"`

- Replaces `(ampersand)nbsp;` with a non-breaking space, decimal 160

- Replaces `(ampersand)lt;` with a \"less than\" symbol

- Replaces `(ampersand)gt;` with `>`

- Replaces characters that are represented in hexadecimal format, `(ampersand)#xhhhh;`, with the corresponding characters

- Replaces characters that are represented in decimal format, `(ampersand)#nnnn;`, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify `NONE` if you don't want to perform any text transformations.

" } }, "documentation":"

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

" }, "XssMatchTuples":{ "type":"list", "member":{"shape":"XssMatchTuple"} }, "errorMessage":{"type":"string"} }, "documentation":"

This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

This is the AWS WAF Regional Classic API Reference for using AWS WAF Classic with the AWS resources, Elastic Load Balancing (ELB) Application Load Balancers and API Gateway APIs. The AWS WAF Classic actions and data types listed in the reference are available for protecting Elastic Load Balancing (ELB) Application Load Balancers and API Gateway APIs. You can use these actions and data types by means of the endpoints listed in AWS Regions and Endpoints. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the AWS WAF Classic in the developer guide.

" }