models.waf-2015-08-24-model.json Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf Show documentation
{
"version":"2.0",
"metadata":{
"apiVersion":"2015-08-24",
"endpointPrefix":"waf",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"WAF",
"serviceFullName":"AWS WAF",
"signatureVersion":"v4",
"targetPrefix":"AWSWAF_20150824"
},
"operations":{
"CreateByteMatchSet":{
"name":"CreateByteMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateByteMatchSetRequest"},
"output":{"shape":"CreateByteMatchSetResponse"},
"errors":[
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.
To create and configure a ByteMatchSet, perform the following steps:
- Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a CreateByteMatchSet request. - Submit a
CreateByteMatchSet request. - Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. - Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
"
},
"CreateIPSet":{
"name":"CreateIPSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateIPSetRequest"},
"output":{"shape":"CreateIPSetResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"Creates an IPSet, which you use to specify which web requests you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.
To create and configure an IPSet, perform the following steps:
- Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a CreateIPSet request. - Submit a
CreateIPSet request. - Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. - Submit an
UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
"
},
"CreateRule":{
"name":"CreateRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateRuleRequest"},
"output":{"shape":"CreateRuleResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose you add the following to a Rule:
- An
IPSet that matches the IP address 192.0.2.44/32 - A
ByteMatchSet that matches BadBot in the User-Agent header
You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.
To create and configure a Rule, perform the following steps:
- Create and update the predicates that you want to include in the
Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. - Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a CreateRule request. - Submit a
CreateRule request. - Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. - Submit an
UpdateRule request to specify the predicates that you want to include in the Rule. - Create and update a
WebACL that contains the Rule. For more information, see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
"
},
"CreateSizeConstraintSet":{
"name":"CreateSizeConstraintSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateSizeConstraintSetRequest"},
"output":{"shape":"CreateSizeConstraintSetResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.
To create and configure a SizeConstraintSet, perform the following steps:
- Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a CreateSizeConstraintSet request. - Submit a
CreateSizeConstraintSet request. - Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. - Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
"
},
"CreateSqlInjectionMatchSet":{
"name":"CreateSqlInjectionMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateSqlInjectionMatchSetRequest"},
"output":{"shape":"CreateSqlInjectionMatchSetResponse"},
"errors":[
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure a SqlInjectionMatchSet, perform the following steps:
- Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a CreateSqlInjectionMatchSet request. - Submit a
CreateSqlInjectionMatchSet request. - Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request. - Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
"
},
"CreateWebACL":{
"name":"CreateWebACL",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateWebACLRequest"},
"output":{"shape":"CreateWebACLResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule.
You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action.
To create and configure a WebACL, perform the following steps:
- Create and update the
ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. - Create and update the
Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. - Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a CreateWebACL request. - Submit a
CreateWebACL request. - Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. - Submit an UpdateWebACL request to specify the
Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.
For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
"
},
"CreateXssMatchSet":{
"name":"CreateXssMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateXssMatchSetRequest"},
"output":{"shape":"CreateXssMatchSetResponse"},
"errors":[
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure an XssMatchSet, perform the following steps:
- Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a CreateXssMatchSet request. - Submit a
CreateXssMatchSet request. - Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. - Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
"
},
"DeleteByteMatchSet":{
"name":"DeleteByteMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteByteMatchSetRequest"},
"output":{"shape":"DeleteByteMatchSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFNonEmptyEntityException"}
],
"documentation":"Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters).
If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.
To permanently delete a ByteMatchSet, perform the following steps:
- Update the
ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. - Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a DeleteByteMatchSet request. - Submit a
DeleteByteMatchSet request.
"
},
"DeleteIPSet":{
"name":"DeleteIPSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteIPSetRequest"},
"output":{"shape":"DeleteIPSetResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFNonEmptyEntityException"}
],
"documentation":"Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses.
If you just want to remove an IPSet from a Rule, use UpdateRule.
To permanently delete an IPSet from AWS WAF, perform the following steps:
- Update the
IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet. - Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a DeleteIPSet request. - Submit a
DeleteIPSet request.
"
},
"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"}
],
"documentation":"Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.
If you just want to remove a Rule from a WebACL, use UpdateWebACL.
To permanently delete a Rule from AWS WAF, perform the following steps:
- Update the
Rule to remove predicates, if any. For more information, see UpdateRule. - Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a DeleteRule request. - Submit a
DeleteRule request.
"
},
"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":"Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters).
If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.
To permanently delete a SizeConstraintSet, perform the following steps:
- Update the
SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet. - Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a DeleteSizeConstraintSet request. - Submit a
DeleteSizeConstraintSet request.
"
},
"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":"Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects.
If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule.
To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps:
- Update the
SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. - Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a DeleteSqlInjectionMatchSet request. - Submit a
DeleteSqlInjectionMatchSet request.
"
},
"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"}
],
"documentation":"Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.
To delete a WebACL, perform the following steps:
- Update the
WebACL to remove Rules, if any. For more information, see UpdateWebACL. - Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a DeleteWebACL request. - Submit a
DeleteWebACL request.
"
},
"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":"Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects.
If you just want to remove an XssMatchSet from a Rule, use UpdateRule.
To permanently delete an XssMatchSet from AWS WAF, perform the following steps:
- Update the
XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. - Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a DeleteXssMatchSet request. - Submit a
DeleteXssMatchSet request.
"
},
"GetByteMatchSet":{
"name":"GetByteMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetByteMatchSetRequest"},
"output":{"shape":"GetByteMatchSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"Returns the ByteMatchSet specified by ByteMatchSetId.
"
},
"GetChangeToken":{
"name":"GetChangeToken",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetChangeTokenRequest"},
"output":{"shape":"GetChangeTokenResponse"},
"errors":[
{"shape":"WAFInternalErrorException"}
],
"documentation":"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":"Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values:
PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.IN_SYNC: Propagation is complete.
"
},
"GetIPSet":{
"name":"GetIPSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetIPSetRequest"},
"output":{"shape":"GetIPSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"Returns the IPSet that is specified by IPSetId.
"
},
"GetRule":{
"name":"GetRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetRuleRequest"},
"output":{"shape":"GetRuleResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"Returns the Rule that is specified by the RuleId that you included in the GetRule request.
"
},
"GetSampledRequests":{
"name":"GetSampledRequests",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetSampledRequestsRequest"},
"output":{"shape":"GetSampledRequestsResponse"},
"errors":[
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFInternalErrorException"}
],
"documentation":"Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 100 requests, and you can specify any time range in the previous three hours.
GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.
"
},
"GetSizeConstraintSet":{
"name":"GetSizeConstraintSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetSizeConstraintSetRequest"},
"output":{"shape":"GetSizeConstraintSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"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":"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":"Returns the WebACL that is specified by WebACLId.
"
},
"GetXssMatchSet":{
"name":"GetXssMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetXssMatchSetRequest"},
"output":{"shape":"GetXssMatchSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"Returns the XssMatchSet that is specified by XssMatchSetId.
"
},
"ListByteMatchSets":{
"name":"ListByteMatchSets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListByteMatchSetsRequest"},
"output":{"shape":"ListByteMatchSetsResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"}
],
"documentation":"Returns an array of ByteMatchSetSummary objects.
"
},
"ListIPSets":{
"name":"ListIPSets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListIPSetsRequest"},
"output":{"shape":"ListIPSetsResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"}
],
"documentation":"Returns an array of IPSetSummary objects in the response.
"
},
"ListRules":{
"name":"ListRules",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListRulesRequest"},
"output":{"shape":"ListRulesResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"}
],
"documentation":"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":"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":"Returns an array of SqlInjectionMatchSet objects.
"
},
"ListWebACLs":{
"name":"ListWebACLs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListWebACLsRequest"},
"output":{"shape":"ListWebACLsResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"}
],
"documentation":"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":"Returns an array of XssMatchSet objects.
"
},
"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":"Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:
- Whether to insert or delete the object from the array. If you want to change a
ByteMatchSetUpdate object, you delete the existing object and add a new one. - The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
User-Agent header. - The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see
TargetString in the ByteMatchTuple data type. - Where to look, such as at the beginning or the end of a query string.
- Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.
To create and configure a ByteMatchSet, perform the following steps:
- Create a
ByteMatchSet. For more information, see CreateByteMatchSet. - Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of an UpdateByteMatchSet request. - Submit an
UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
"
},
"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":"Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:
- Whether to insert or delete the object from the array. If you want to change an
IPSetDescriptor object, you delete the existing object and add a new one. - The IP address version,
IPv4. - The IP address in CIDR notation, for example,
192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).
AWS WAF supports /8, /16, /24, and /32 IP address ranges. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.
To create and configure an IPSet, perform the following steps:
- Submit a CreateIPSet request.
- Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of an UpdateIPSet request. - Submit an
UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.
When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
"
},
"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":"Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule:
- A
ByteMatchSet that matches the value BadBot in the User-Agent header - An
IPSet that matches the IP address 192.0.2.44
You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.
To create and configure a Rule, perform the following steps:
- Create and update the predicates that you want to include in the
Rule. - Create the
Rule. See CreateRule. - Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. - Submit an
UpdateRule request to add predicates to the Rule. - Create and update a
WebACL that contains the Rule. See CreateWebACL.
If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
"
},
"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":"Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values:
- Whether to insert or delete the object from the array. If you want to change a
SizeConstraintSetUpdate object, you delete the existing object and add a new one. - The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the
User-Agent header. - Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first
8192 bytes of your request to AWS WAF. - A
ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on. - The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.
For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.
To create and configure a SizeConstraintSet, perform the following steps:
- Create a
SizeConstraintSet. For more information, see CreateSizeConstraintSet. - Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of an UpdateSizeConstraintSet request. - Submit an
UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
"
},
"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":"Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.
You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet, perform the following steps:
- Submit a CreateSqlInjectionMatchSet request.
- Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of an UpdateIPSet request. - Submit an
UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
"
},
"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"}
],
"documentation":"Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:
- A default action for the
WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL. - The
Rules that you want to add and/or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one. - For each
Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule. - The order in which you want AWS WAF to evaluate the
Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all of the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any. - The CloudFront distribution that you want to associate with the
WebACL.
To create and configure a WebACL, perform the following steps:
- Create and update the predicates that you want to include in
Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. - Create and update the
Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. - Create a
WebACL. See CreateWebACL. - Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. - Submit an
UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.
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":"Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change a XssMatchTuple, you delete the existing object and add a new one.FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.
You use XssMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure an XssMatchSet, perform the following steps:
- Submit a CreateXssMatchSet request.
- Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of an UpdateIPSet request. - Submit an
UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
"
}
},
"shapes":{
"Action":{"type":"string"},
"ActivatedRule":{
"type":"structure",
"required":[
"Priority",
"RuleId",
"Action"
],
"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.
"
}
},
"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).
To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.
"
},
"ActivatedRules":{
"type":"list",
"member":{"shape":"ActivatedRule"}
},
"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":"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":"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":"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"}
},
"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.
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 TargetString before inspecting a request for a match.
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.
"
},
"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":"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"},
"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.
"
}
}
},
"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.
"
}
}
},
"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); the name can't contain whitespace. 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.
"
}
}
},
"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":""
},
"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.
"
},
"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); the name can't contain whitespace. 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.
"
}
}
},
"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.
"
}
}
},
"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.
"
}
}
},
"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.
"
},
"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.
"
},
"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. If the value of Type is any other value, omit Data.
The name of the header is not case sensitive.
"
}
},
"documentation":"Specifies where in a web request to look for TargetString.
"
},
"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.
"
}
}
},
"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
"
}
}
},
"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
"
}
}
},
"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 two values:
- The
RuleId of the Rule 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. Specify the date and time in Unix time format (in seconds). You can specify any time range in the previous three hours.
"
},
"MaxItems":{
"shape":"ListMaxItems",
"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.
"
}
}
},
"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.
"
},
"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 TypeRules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleIdAction: 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":"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 requestx-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":"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) and the IP address range (in CIDR notation) that web requests originate 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 requestx-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request
"
}
},
"documentation":"Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify a /24, a /16, or a /8 CIDR. For more information about CIDR notation, perform an Internet search on cidr notation.
"
},
"IPSetDescriptor":{
"type":"structure",
"required":[
"Type",
"Value"
],
"members":{
"Type":{
"shape":"IPSetDescriptorType",
"documentation":"Specify IPV4.
"
},
"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.
AWS WAF supports only /8, /16, /24, and /32 IP addresses.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
"
}
},
"documentation":"Specifies the IP address type (IPV4) and the IP address range (in CIDR format) that web requests originate from.
"
},
"IPSetDescriptorType":{
"type":"string",
"enum":["IPV4"]
},
"IPSetDescriptorValue":{"type":"string"},
"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":"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) and the IP address range (in CIDR notation) that web requests originate from.
"
}
},
"documentation":"Specifies the type of update to perform to an IPSet with UpdateIPSet.
"
},
"IPSetUpdates":{
"type":"list",
"member":{"shape":"IPSetUpdate"}
},
"IPString":{"type":"string"},
"ListByteMatchSetsRequest":{
"type":"structure",
"required":["Limit"],
"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.
"
}
}
},
"ListIPSetsRequest":{
"type":"structure",
"required":["Limit"],
"members":{
"NextMarker":{
"shape":"NextMarker",
"documentation":"If you specify a value for Limit and you have more IPSets than the value of Limit, 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 ByteMatchSets.
"
},
"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":"If you have more IPSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more IPSet objects, submit another ListIPSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
"
},
"IPSets":{
"shape":"IPSetSummaries",
"documentation":"An array of IPSetSummary objects.
"
}
}
},
"ListMaxItems":{
"type":"long",
"max":100,
"min":1
},
"ListRulesRequest":{
"type":"structure",
"required":["Limit"],
"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",
"required":["Limit"],
"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",
"required":["Limit"],
"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.
"
},
"ListWebACLsRequest":{
"type":"structure",
"required":["Limit"],
"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",
"required":["Limit"],
"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.
"
},
"MatchFieldData":{"type":"string"},
"MatchFieldType":{
"type":"string",
"enum":[
"URI",
"QUERY_STRING",
"HEADER",
"METHOD",
"BODY"
]
},
"MetricName":{"type":"string"},
"Negated":{"type":"boolean"},
"NextMarker":{
"type":"string",
"min":1
},
"PaginationLimit":{
"type":"integer",
"max":100,
"min":1
},
"ParameterExceptionField":{
"type":"string",
"enum":[
"CHANGE_ACTION",
"WAF_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"
]
},
"ParameterExceptionParameter":{
"type":"string",
"min":1
},
"ParameterExceptionReason":{
"type":"string",
"enum":[
"INVALID_OPTION",
"ILLEGAL_COMBINATION"
]
},
"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, 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, 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 ByteMatchSet 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":"Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, 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",
"SizeConstraint",
"XssMatch"
]
},
"Predicates":{
"type":"list",
"member":{"shape":"Predicate"}
},
"ResourceId":{
"type":"string",
"max":128,
"min":1
},
"ResourceName":{
"type":"string",
"max":128,
"min":1
},
"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"},
"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":"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.
"
},
"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":"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":"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"}
},
"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.
"
}
},
"documentation":"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"},
"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 a request for a match.
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":"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":"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":"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":"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"}
},
"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":"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":"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":"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"}
},
"SqlInjectionMatchTuple":{
"type":"structure",
"required":[
"FieldToMatch",
"TextTransformation"
],
"members":{
"FieldToMatch":{"shape":"FieldToMatch"},
"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 a request for a match.
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.
"
}
},
"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.
"
},
"SqlInjectionMatchTuples":{
"type":"list",
"member":{"shape":"SqlInjectionMatchTuple"}
},
"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 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 can specify any time range in the previous three hours.
"
}
},
"documentation":"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.
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"},
"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.
"
}
}
},
"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
"
}
}
},
"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.
"
}
}
},
"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, Priority, and RuleId - WafAction: Contains
Type
"
},
"DefaultAction":{"shape":"WafAction"}
}
},
"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 a 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.
"
},
"WAFDisallowedNameException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
},
"documentation":"The name specified is invalid.
",
"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 an IP address to an
IPSet, but the IP address already exists in the specified IPSet. - You tried to add a
ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.
",
"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 update a
WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. - You tried to update a
ByteMatchSet with a FieldToMatch Type other than HEADER, QUERY_STRING, or URI. - You tried to update a
ByteMatchSet with a Field of HEADER but no value for Data.
",
"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
},
"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
},
"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 requestsBLOCK: AWS WAF blocks requestsCOUNT: 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":"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"
]
},
"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"},
"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.
"
}
},
"documentation":"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":"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":"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":"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":"The Id and Name of an XssMatchSet.
"
},
"XssMatchSetUpdate":{
"type":"structure",
"required":[
"Action",
"XssMatchTuple"
],
"members":{
"Action":{
"shape":"ChangeAction",
"documentation":"Specify INSERT to add a XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove a 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":"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"}
},
"XssMatchTuple":{
"type":"structure",
"required":[
"FieldToMatch",
"TextTransformation"
],
"members":{
"FieldToMatch":{"shape":"FieldToMatch"},
"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 a request for a match.
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.
"
}
},
"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.
"
},
"XssMatchTuples":{
"type":"list",
"member":{"shape":"XssMatchTuple"}
},
"errorMessage":{"type":"string"}
},
"documentation":"This is the AWS WAF API Reference. This guide is for developers who need detailed information about the AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.
"
}