{
"smithy": "1.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.wafregional#AWSWAF_Regional_20161128": {
"type": "service",
"version": "2016-11-28",
"operations": [
{
"target": "com.amazonaws.wafregional#AssociateWebACL"
},
{
"target": "com.amazonaws.wafregional#CreateByteMatchSet"
},
{
"target": "com.amazonaws.wafregional#CreateGeoMatchSet"
},
{
"target": "com.amazonaws.wafregional#CreateIPSet"
},
{
"target": "com.amazonaws.wafregional#CreateRateBasedRule"
},
{
"target": "com.amazonaws.wafregional#CreateRegexMatchSet"
},
{
"target": "com.amazonaws.wafregional#CreateRegexPatternSet"
},
{
"target": "com.amazonaws.wafregional#CreateRule"
},
{
"target": "com.amazonaws.wafregional#CreateRuleGroup"
},
{
"target": "com.amazonaws.wafregional#CreateSizeConstraintSet"
},
{
"target": "com.amazonaws.wafregional#CreateSqlInjectionMatchSet"
},
{
"target": "com.amazonaws.wafregional#CreateWebACL"
},
{
"target": "com.amazonaws.wafregional#CreateWebACLMigrationStack"
},
{
"target": "com.amazonaws.wafregional#CreateXssMatchSet"
},
{
"target": "com.amazonaws.wafregional#DeleteByteMatchSet"
},
{
"target": "com.amazonaws.wafregional#DeleteGeoMatchSet"
},
{
"target": "com.amazonaws.wafregional#DeleteIPSet"
},
{
"target": "com.amazonaws.wafregional#DeleteLoggingConfiguration"
},
{
"target": "com.amazonaws.wafregional#DeletePermissionPolicy"
},
{
"target": "com.amazonaws.wafregional#DeleteRateBasedRule"
},
{
"target": "com.amazonaws.wafregional#DeleteRegexMatchSet"
},
{
"target": "com.amazonaws.wafregional#DeleteRegexPatternSet"
},
{
"target": "com.amazonaws.wafregional#DeleteRule"
},
{
"target": "com.amazonaws.wafregional#DeleteRuleGroup"
},
{
"target": "com.amazonaws.wafregional#DeleteSizeConstraintSet"
},
{
"target": "com.amazonaws.wafregional#DeleteSqlInjectionMatchSet"
},
{
"target": "com.amazonaws.wafregional#DeleteWebACL"
},
{
"target": "com.amazonaws.wafregional#DeleteXssMatchSet"
},
{
"target": "com.amazonaws.wafregional#DisassociateWebACL"
},
{
"target": "com.amazonaws.wafregional#GetByteMatchSet"
},
{
"target": "com.amazonaws.wafregional#GetChangeToken"
},
{
"target": "com.amazonaws.wafregional#GetChangeTokenStatus"
},
{
"target": "com.amazonaws.wafregional#GetGeoMatchSet"
},
{
"target": "com.amazonaws.wafregional#GetIPSet"
},
{
"target": "com.amazonaws.wafregional#GetLoggingConfiguration"
},
{
"target": "com.amazonaws.wafregional#GetPermissionPolicy"
},
{
"target": "com.amazonaws.wafregional#GetRateBasedRule"
},
{
"target": "com.amazonaws.wafregional#GetRateBasedRuleManagedKeys"
},
{
"target": "com.amazonaws.wafregional#GetRegexMatchSet"
},
{
"target": "com.amazonaws.wafregional#GetRegexPatternSet"
},
{
"target": "com.amazonaws.wafregional#GetRule"
},
{
"target": "com.amazonaws.wafregional#GetRuleGroup"
},
{
"target": "com.amazonaws.wafregional#GetSampledRequests"
},
{
"target": "com.amazonaws.wafregional#GetSizeConstraintSet"
},
{
"target": "com.amazonaws.wafregional#GetSqlInjectionMatchSet"
},
{
"target": "com.amazonaws.wafregional#GetWebACL"
},
{
"target": "com.amazonaws.wafregional#GetWebACLForResource"
},
{
"target": "com.amazonaws.wafregional#GetXssMatchSet"
},
{
"target": "com.amazonaws.wafregional#ListActivatedRulesInRuleGroup"
},
{
"target": "com.amazonaws.wafregional#ListByteMatchSets"
},
{
"target": "com.amazonaws.wafregional#ListGeoMatchSets"
},
{
"target": "com.amazonaws.wafregional#ListIPSets"
},
{
"target": "com.amazonaws.wafregional#ListLoggingConfigurations"
},
{
"target": "com.amazonaws.wafregional#ListRateBasedRules"
},
{
"target": "com.amazonaws.wafregional#ListRegexMatchSets"
},
{
"target": "com.amazonaws.wafregional#ListRegexPatternSets"
},
{
"target": "com.amazonaws.wafregional#ListResourcesForWebACL"
},
{
"target": "com.amazonaws.wafregional#ListRuleGroups"
},
{
"target": "com.amazonaws.wafregional#ListRules"
},
{
"target": "com.amazonaws.wafregional#ListSizeConstraintSets"
},
{
"target": "com.amazonaws.wafregional#ListSqlInjectionMatchSets"
},
{
"target": "com.amazonaws.wafregional#ListSubscribedRuleGroups"
},
{
"target": "com.amazonaws.wafregional#ListTagsForResource"
},
{
"target": "com.amazonaws.wafregional#ListWebACLs"
},
{
"target": "com.amazonaws.wafregional#ListXssMatchSets"
},
{
"target": "com.amazonaws.wafregional#PutLoggingConfiguration"
},
{
"target": "com.amazonaws.wafregional#PutPermissionPolicy"
},
{
"target": "com.amazonaws.wafregional#TagResource"
},
{
"target": "com.amazonaws.wafregional#UntagResource"
},
{
"target": "com.amazonaws.wafregional#UpdateByteMatchSet"
},
{
"target": "com.amazonaws.wafregional#UpdateGeoMatchSet"
},
{
"target": "com.amazonaws.wafregional#UpdateIPSet"
},
{
"target": "com.amazonaws.wafregional#UpdateRateBasedRule"
},
{
"target": "com.amazonaws.wafregional#UpdateRegexMatchSet"
},
{
"target": "com.amazonaws.wafregional#UpdateRegexPatternSet"
},
{
"target": "com.amazonaws.wafregional#UpdateRule"
},
{
"target": "com.amazonaws.wafregional#UpdateRuleGroup"
},
{
"target": "com.amazonaws.wafregional#UpdateSizeConstraintSet"
},
{
"target": "com.amazonaws.wafregional#UpdateSqlInjectionMatchSet"
},
{
"target": "com.amazonaws.wafregional#UpdateWebACL"
},
{
"target": "com.amazonaws.wafregional#UpdateXssMatchSet"
}
],
"traits": {
"aws.api#service": {
"sdkId": "WAF Regional",
"arnNamespace": "waf-regional",
"cloudFormationName": "WAFRegional",
"cloudTrailEventSource": "wafregional.amazonaws.com",
"endpointPrefix": "waf-regional"
},
"aws.auth#sigv4": {
"name": "waf-regional"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": " This is AWS WAF Classic Regional documentation. For\n more information, see AWS\n WAF Classic in the developer guide. \n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
This is the AWS WAF Regional Classic API Reference for using AWS WAF Classic with the AWS resources, Elastic Load Balancing (ELB) Application Load Balancers and API Gateway APIs. The AWS WAF Classic actions and data types listed in the reference are available for protecting Elastic Load Balancing (ELB) Application Load Balancers and API Gateway APIs. You can use these actions and data types by means of the endpoints listed in AWS Regions and Endpoints. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the \n AWS\n WAF Classic in the developer guide.
", "smithy.api#title": "AWS WAF Regional", "smithy.api#xmlNamespace": { "uri": "http://waf.amazonaws.com/doc/2015-08-24/" } } }, "com.amazonaws.wafregional#Action": { "type": "string" }, "com.amazonaws.wafregional#ActivatedRule": { "type": "structure", "members": { "Priority": { "target": "com.amazonaws.wafregional#RulePriority", "traits": { "smithy.api#documentation": "Specifies the order in which the Rules
in a WebACL
are evaluated. Rules with a lower value for \n\t\t\tPriority
are evaluated before Rules
with a higher value. The value must be a unique integer. If you add multiple \n\t\t\tRules
to a WebACL
, the values don't need to be consecutive.
The RuleId
for a Rule
. You use RuleId
to get more information about a Rule
(see GetRule), \n\t\t\tupdate a Rule
(see UpdateRule), insert a Rule
into a WebACL
or delete a \n\t\t\tone from a WebACL
(see UpdateWebACL), or delete a Rule
from AWS WAF (see DeleteRule).
\n RuleId
is returned by CreateRule and by ListRules.
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule
. \n\t\t\tValid values for Action
include the following:
\n ALLOW
: CloudFront responds with the requested object.
\n BLOCK
: CloudFront responds with an HTTP 403 (Forbidden) status code.
\n COUNT
: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to \n\t\t\t\t\tinspect the web request based on the remaining rules in the web ACL.
\n ActivatedRule|OverrideAction
applies only when updating or adding a\n RuleGroup
to a WebACL
. In this\n case,\n you do not use ActivatedRule|Action
. For all other update requests,\n ActivatedRule|Action
is used instead of\n ActivatedRule|OverrideAction
.
Use the OverrideAction
to test your RuleGroup
.
Any rule in a RuleGroup
can potentially block a request. If you set the OverrideAction
to None
, the RuleGroup
will block a request if any individual rule in the RuleGroup
matches the request and is configured to block that request. However if you first want to test the RuleGroup
, set the OverrideAction
to Count
. The RuleGroup
will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.
\n ActivatedRule|OverrideAction
applies only when updating or adding a RuleGroup
to a WebACL
. In this case you do not use ActivatedRule|Action
. For all other update requests, ActivatedRule|Action
is used instead of ActivatedRule|OverrideAction
.
The rule type, either REGULAR
, as defined by Rule, RATE_BASED
, as defined by RateBasedRule, or GROUP
, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist. \t\t\n\t\t\t
An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule
refers to a RuleGroup
.
Sometimes it is necessary to troubleshoot rule groups that are blocking traffic\n unexpectedly (false positives). One troubleshooting technique is to identify the specific\n rule within the rule group that is blocking the legitimate traffic and then disable\n (exclude) that particular rule. You can exclude rules from both your own rule groups and\n AWS Marketplace rule groups that have been associated with a web ACL.
\nSpecifying ExcludedRules
does not remove those rules from the rule group.\n Rather, it changes the action for the rules to COUNT
. Therefore, requests that\n match an ExcludedRule
are counted but not blocked. The RuleGroup
\n owner will receive COUNT metrics for each ExcludedRule
.
If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:
\nUse the AWS WAF logs to identify the IDs of the rules that you want to exclude.\n For more information about the logs, see Logging Web ACL Traffic\n Information.
\nSubmit an UpdateWebACL request that has two actions:
\nThe first action\n deletes\n the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action
\n should be DELETE
and Updates:ActivatedRule:RuleId
\n should be the rule group that contains the rules that you want to\n exclude.
The second action\n inserts\n the same rule group back in, but specifying the rules to exclude. That is, the\n second Updates:Action
should be INSERT
,\n Updates:ActivatedRule:RuleId
should be the rule group that you\n just removed, and ExcludedRules
should contain the rules that you\n want to exclude.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe ActivatedRule
object in an UpdateWebACL request specifies a Rule
that you want to insert or delete, \n\t\t\tthe priority of the Rule
in the WebACL
, and the action that you want AWS WAF to take when a web request matches the Rule
\n\t\t\t(ALLOW
, BLOCK
, or COUNT
).
To specify whether to insert or delete a Rule
, use the Action
parameter in the WebACLUpdate data type.
This is AWS WAF Classic Regional documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nAssociates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage.
" } }, "com.amazonaws.wafregional#AssociateWebACLRequest": { "type": "structure", "members": { "WebACLId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "A unique identifier (ID) for the web ACL.
", "smithy.api#required": {} } }, "ResourceArn": { "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "The ARN (Amazon Resource Name) of the resource to be protected, either an application load balancer or Amazon API Gateway stage.
\nThe ARN should be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n
\n
For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n
\n
The ByteMatchSetId
for a ByteMatchSet
. You use ByteMatchSetId
to get information about a \n\t\t\tByteMatchSet
(see GetByteMatchSet), update a ByteMatchSet
(see UpdateByteMatchSet), \n\t\t\tinsert a ByteMatchSet
into a Rule
or delete one from a Rule
(see UpdateRule), and \n\t\t\tdelete a ByteMatchSet
from AWS WAF (see DeleteByteMatchSet).
\n ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.
A friendly name or description of the ByteMatchSet. You can't change Name
after you create a ByteMatchSet
.
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.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nIn a GetByteMatchSet request, ByteMatchSet
is a complex type that contains the ByteMatchSetId
and \n\t\t\tName
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 \n\t\t\twant AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet
contains more than one \n\t\t\tByteMatchTuple
object, a request needs to match the settings in only one ByteMatchTuple
\n\t\t\tto be considered a match.
The ByteMatchSetId
for a ByteMatchSet
. You use ByteMatchSetId
to get information about a ByteMatchSet
,\n\t\t\tupdate a ByteMatchSet
, remove a ByteMatchSet
from a Rule
, and delete a ByteMatchSet
from AWS WAF.
\n ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.
A friendly name or description of the ByteMatchSet. You can't change Name
after you create a ByteMatchSet
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturned by ListByteMatchSets. Each ByteMatchSetSummary
object includes the Name
and \n\t\t\tByteMatchSetId
for one ByteMatchSet.
Specifies whether to insert or delete a ByteMatchTuple.
", "smithy.api#required": {} } }, "ByteMatchTuple": { "target": "com.amazonaws.wafregional#ByteMatchTuple", "traits": { "smithy.api#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.\n\t\t\tIf you specify DELETE
for the value of Action
, the ByteMatchTuple
values must \n\t\t\texactly match the values in the ByteMatchTuple
that you want to delete from the ByteMatchSet
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nIn an UpdateByteMatchSet request, ByteMatchSetUpdate
specifies whether to insert or delete a \n\t\t\tByteMatchTuple and includes the settings for the ByteMatchTuple
.
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 \n\t\t\tFieldToMatch.
", "smithy.api#required": {} } }, "TargetString": { "target": "com.amazonaws.wafregional#ByteMatchTargetString", "traits": { "smithy.api#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 \n\t\t\tspecified in FieldToMatch
. The maximum length of the value is 50 bytes.
Valid values depend on the values that you specified for FieldToMatch
:
\n HEADER
: The value that you want AWS WAF to search for in the request header that you specified in \n\t\t\t\tFieldToMatch, for example, the value of the User-Agent
or Referer
header.
\n METHOD
: The HTTP method, which indicates the type of operation specified in the request. \n\t\t\t\tCloudFront supports the following methods: DELETE
, GET
, HEAD
, OPTIONS
, \n\t\t\t\tPATCH
, POST
, and PUT
.
\n QUERY_STRING
: The value that you want AWS WAF to search for in the query string, which is the part \n\t\t\t\tof a URL that appears after a ?
character.
\n URI
: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, \n\t\t\t\tfor example, /images/daily-ad.jpg
.
\n BODY
: The part of a request that contains any additional data that you want to send to your web server \n\t\t\t\tas the HTTP request body, such as data from a form. The request body immediately follows the request headers. \n\t\t\t\tNote that only the first 8192
bytes of the request body are forwarded to AWS WAF for inspection. \n\t\t\t\tTo allow or block requests based on the length of the body, you can create a size constraint set. \n\t\t\t\tFor more information, see CreateSizeConstraintSet.
\n\t\t SINGLE_QUERY_ARG
: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG
is 30 characters.
\n ALL_QUERY_ARGS
: Similar to SINGLE_QUERY_ARG
, but instead of\n inspecting a single parameter, AWS WAF inspects all parameters within the query\n string for the value or regex pattern that you specify in\n TargetString
.
If TargetString
includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
\n If you're using the AWS WAF API\n
\n\t\tSpecify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
\n\t\tFor example, suppose the value of Type
is HEADER
and the\n value of Data
is User-Agent
. If you want to search the\n User-Agent
header for the value BadBot
, you base64-encode\n BadBot
using MIME\n base64-encoding\n and include the resulting value, QmFkQm90
, in the value of\n TargetString
.
\n If you're using the AWS CLI or one of the AWS SDKs\n
\n\t\tThe value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
", "smithy.api#required": {} } }, "TextTransformation": { "target": "com.amazonaws.wafregional#TextTransformation", "traits": { "smithy.api#documentation": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on FieldToMatch
before inspecting it for a match.
You can only specify a single type of TextTransformation.
\t\t\t\n\t\t\n CMD_LINE\n
\n\t\tWhen you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:
\n\t\tDelete the following characters: \\ \" ' ^
\nDelete spaces before the following characters: / (
\nReplace the following characters with a space: , ;
\nReplace multiple spaces with one space
\nConvert uppercase letters (A-Z) to lowercase (a-z)
\n\n COMPRESS_WHITE_SPACE\n
\n\t\tUse this option to replace the following characters with a space character (decimal 32):
\n\t\t\\f, formfeed, decimal 12
\n\\t, tab, decimal 9
\n\\n, newline, decimal 10
\n\\r, carriage return, decimal 13
\n\\v, vertical tab, decimal 11
\nnon-breaking space, decimal 160
\n\n COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
\n HTML_ENTITY_DECODE\n
\n\t\tUse this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs \n\t\t\tthe following operations:
Replaces (ampersand)quot;
with \"
\n
Replaces (ampersand)nbsp;
with a non-breaking space, decimal 160
Replaces (ampersand)lt;
with a \"less than\" symbol
Replaces (ampersand)gt;
with >
\n
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;
, with the corresponding \n\t\t\t\tcharacters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;
, with the corresponding \n\t\t\t\tcharacters
\n LOWERCASE\n
\n\t\tUse this option to convert uppercase letters (A-Z) to lowercase (a-z).
\t\t\n\t\t\n URL_DECODE\n
\n\t\tUse this option to decode a URL-encoded value.
\t\t\n\t\t\n NONE\n
\n\t\tSpecify NONE
if you don't want to perform any text transformations.
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:
\n\t\t\n CONTAINS\n
\n\t\tThe specified part of the web request must include the value of TargetString
, but the location doesn't matter.
\n CONTAINS_WORD\n
\n\t\tThe specified part of the web request must include the value of TargetString
, and \n\t\t\tTargetString
must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, \n\t\t\tTargetString
must be a word, which means one of the following:
\n TargetString
exactly matches the value of the specified part of the web request, such as the value of a \n\t\t\t\t\theader.
\n TargetString
is at the beginning of the specified part of the web request and is followed by a character \n\t\t\t\t\tother than an alphanumeric character or underscore (_), for example, BadBot;
.
\n TargetString
is at the end of the specified part of the web request and is preceded by a character \n\t\t\t\t\tother than an alphanumeric character or underscore (_), for example, ;BadBot
.
\n TargetString
is in the middle of the specified part of the web request and is preceded and followed \n\t\t\t\t\tby characters other than alphanumeric characters or underscore (_), for example, -BadBot;
.
\n EXACTLY\n
\n\t\tThe value of the specified part of the web request must exactly match the value of TargetString
.
\n STARTS_WITH\n
\n\t\tThe value of TargetString
must appear at the beginning of the specified part of the web request.
\n ENDS_WITH\n
\n\t\tThe value of TargetString
must appear at the end of the specified part of the web request.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe 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.
" } }, "com.amazonaws.wafregional#ByteMatchTuples": { "type": "list", "member": { "target": "com.amazonaws.wafregional#ByteMatchTuple" } }, "com.amazonaws.wafregional#ChangeAction": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "INSERT", "name": "INSERT" }, { "value": "DELETE", "name": "DELETE" } ] } }, "com.amazonaws.wafregional#ChangeToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.wafregional#ChangeTokenStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PROVISIONED", "name": "PROVISIONED" }, { "value": "PENDING", "name": "PENDING" }, { "value": "INSYNC", "name": "INSYNC" } ] } }, "com.amazonaws.wafregional#ComparisonOperator": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "EQ", "name": "EQ" }, { "value": "NE", "name": "NE" }, { "value": "LE", "name": "LE" }, { "value": "LT", "name": "LT" }, { "value": "GE", "name": "GE" }, { "value": "GT", "name": "GT" } ] } }, "com.amazonaws.wafregional#Country": { "type": "string" }, "com.amazonaws.wafregional#CreateByteMatchSet": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#CreateByteMatchSetRequest" }, "output": { "target": "com.amazonaws.wafregional#CreateByteMatchSetResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFDisallowedNameException" }, { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" }, { "target": "com.amazonaws.wafregional#WAFInvalidParameterException" }, { "target": "com.amazonaws.wafregional#WAFLimitsExceededException" }, { "target": "com.amazonaws.wafregional#WAFStaleDataException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nCreates a ByteMatchSet
. You then use UpdateByteMatchSet to identify the part of a \n\t\t\tweb request that you want AWS WAF to inspect, such as the values of the User-Agent
header or the query string. \n\t\t\tFor example, you can create a ByteMatchSet
that matches any requests with User-Agent
headers \n\t\t\tthat 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 \n\t\t\t\tCreateByteMatchSet
request.
Submit a CreateByteMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateByteMatchSet
request.
Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect \n\t\t\t\t(for example, the header or the URI) and the value that you want AWS WAF to watch for.
\nFor more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#CreateByteMatchSetRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { "smithy.api#documentation": "A friendly name or description of the ByteMatchSet. You can't change Name
after you create a \n\t\t\tByteMatchSet
.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#CreateByteMatchSetResponse": { "type": "structure", "members": { "ByteMatchSet": { "target": "com.amazonaws.wafregional#ByteMatchSet", "traits": { "smithy.api#documentation": "A ByteMatchSet that contains no ByteMatchTuple
objects.
The ChangeToken
that you used to submit the CreateByteMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nCreates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country \n\t\t\tthat the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet
that contains those countries and then configure AWS WAF to block the requests.
To create and configure a GeoMatchSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a \n\t\t\t\tCreateGeoMatchSet
request.
Submit a CreateGeoMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateGeoMatchSet request.
Submit an UpdateGeoMatchSetSet
request to specify the countries that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#CreateGeoMatchSetRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { "smithy.api#documentation": "A friendly name or description of the GeoMatchSet. You can't change Name
after you create the GeoMatchSet
.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#CreateGeoMatchSetResponse": { "type": "structure", "members": { "GeoMatchSet": { "target": "com.amazonaws.wafregional#GeoMatchSet", "traits": { "smithy.api#documentation": "The GeoMatchSet returned in the CreateGeoMatchSet
response. The GeoMatchSet
contains no GeoMatchConstraints
.
The ChangeToken
that you used to submit the CreateGeoMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nCreates an IPSet, which you use to specify which web requests\n that\n you want to allow or block based on the IP addresses that the requests\n originate from. For example, if you're receiving a lot of requests from one or more\n individual IP addresses or one or more ranges of IP addresses and you want to block the\n requests, you can create an IPSet
that contains those IP addresses and then\n 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 \n\t\t\t\tCreateIPSet
request.
Submit a CreateIPSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateIPSet 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 \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#CreateIPSetRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { "smithy.api#documentation": "A friendly name or description of the IPSet. You can't change Name
after you create the IPSet
.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#CreateIPSetResponse": { "type": "structure", "members": { "IPSet": { "target": "com.amazonaws.wafregional#IPSet", "traits": { "smithy.api#documentation": "The IPSet returned in the CreateIPSet
response.
The ChangeToken
that you used to submit the CreateIPSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nCreates a RateBasedRule. The RateBasedRule
contains a\n RateLimit
, which specifies the maximum number of requests that AWS WAF allows\n from a specified IP address in a five-minute period. \n The RateBasedRule
also\n contains the IPSet
objects, ByteMatchSet
objects, and other\n predicates that identify the requests that you want to count or block if these requests\n exceed the RateLimit
.
If you add more than one predicate to a RateBasedRule
, a request not\n only must exceed the RateLimit
, but it also must match all the\n conditions to be counted or blocked. For example, suppose you add the following to a\n RateBasedRule
:
An IPSet
that matches the IP address 192.0.2.44/32
\n
A ByteMatchSet
that matches BadBot
in the\n User-Agent
header
Further, you specify a RateLimit
of 1,000.
You then add the RateBasedRule
to a WebACL
and specify that\n you want to block requests that meet the conditions in the rule. For a request to be\n blocked, it must come from the IP address 192.0.2.44 and the\n User-Agent
header in the request must contain the value\n BadBot
. Further, requests that match these two conditions must be received at\n a rate of more than 1,000 requests every five minutes. If both conditions are met and the\n rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a\n five-minute period, AWS WAF no longer blocks the requests.
As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a\n RateBasedRule
:
A ByteMatchSet
with FieldToMatch
of URI
\n
A PositionalConstraint
of STARTS_WITH
\n
A TargetString
of login
\n
Further, you specify a RateLimit
of 1,000.
By adding this RateBasedRule
to a WebACL
, you could limit requests to your login page without affecting the rest of your site.
To create and configure a RateBasedRule
, perform the following\n steps:
Create and update the predicates that you want to include in the rule. For more\n information, see CreateByteMatchSet, CreateIPSet,\n and CreateSqlInjectionMatchSet.
\nUse GetChangeToken to get the change token that you provide\n in the ChangeToken
parameter of a CreateRule
\n request.
Submit a CreateRateBasedRule
request.
Use GetChangeToken
to get the change token that you provide in the\n ChangeToken
parameter of an UpdateRule\n request.
Submit an UpdateRateBasedRule
request to specify the predicates\n that you want to include in the rule.
Create and update a WebACL
that contains the\n RateBasedRule
. For more information, see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests,\n see the AWS WAF Developer\n Guide.
" } }, "com.amazonaws.wafregional#CreateRateBasedRuleRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { "smithy.api#documentation": "A friendly name or description of the RateBasedRule. You can't\n change the name of a RateBasedRule
after you create it.
A friendly name or description for the metrics for this RateBasedRule
.\n The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the\n RateBasedRule
.
The field that AWS WAF uses to determine if requests are likely arriving from a single\n source and thus subject to rate monitoring. The only valid value for RateKey
\n is IP
. IP
indicates that requests that arrive from the same IP\n address are subject to the RateLimit
that is specified in\n the RateBasedRule
.
The maximum number of requests, which have an identical value in the field that is\n specified by RateKey
, allowed in a five-minute period. If the number of\n requests exceeds the RateLimit
and the other predicates specified in the rule\n are also met, AWS WAF triggers the action that is specified for this rule.
The ChangeToken
that you used to submit the\n CreateRateBasedRule
request. You can also use this value to query the\n status of the request. For more information, see GetChangeTokenStatus.
The RateBasedRule\n that is returned in the CreateRateBasedRule
response.
The ChangeToken
that you used to submit the\n CreateRateBasedRule
request. You can also use this value to query the\n status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nCreates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a \n web request that you want AWS WAF to inspect, such as the values of the User-Agent
header or the query string. \n For example, you can create a RegexMatchSet
that contains a RegexMatchTuple
that looks for any requests with User-Agent
headers \n that match a RegexPatternSet
with pattern B[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.
To create and configure a RegexMatchSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a \n CreateRegexMatchSet
request.
Submit a CreateRegexMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an \n UpdateRegexMatchSet
request.
Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect \n (for example, the header or the URI) and the value, using a RegexPatternSet
, that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n AWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#CreateRegexMatchSetRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { "smithy.api#documentation": "A friendly name or description of the RegexMatchSet. You can't change Name
after you create a \n\t\t\tRegexMatchSet
.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#CreateRegexMatchSetResponse": { "type": "structure", "members": { "RegexMatchSet": { "target": "com.amazonaws.wafregional#RegexMatchSet", "traits": { "smithy.api#documentation": "A RegexMatchSet that contains no RegexMatchTuple
objects.
The ChangeToken
that you used to submit the CreateRegexMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nCreates a RegexPatternSet
. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.
To create and configure a RegexPatternSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a \n CreateRegexPatternSet
request.
Submit a CreateRegexPatternSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an \n UpdateRegexPatternSet
request.
Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.
\nFor more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n AWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#CreateRegexPatternSetRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { "smithy.api#documentation": "A friendly name or description of the RegexPatternSet. You can't change Name
after you create a \n\t\t\tRegexPatternSet
.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#CreateRegexPatternSetResponse": { "type": "structure", "members": { "RegexPatternSet": { "target": "com.amazonaws.wafregional#RegexPatternSet", "traits": { "smithy.api#documentation": "A RegexPatternSet that contains no objects.
" } }, "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the CreateRegexPatternSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nCreates a Rule
, which contains the IPSet
objects,\n ByteMatchSet
objects, and other predicates that identify the requests that\n you want to block. If you add more than one predicate to a Rule
, a request\n must match all of the specifications to be allowed or blocked. For example, suppose\n that\n you add the following to a Rule
:
An IPSet
that matches the IP address 192.0.2.44/32
\n
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
. \n\t\t\tFor a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent
header in the request \n\t\t\tmust 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 \n\t\t\t\tCreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a \n\t\t\t\tCreateRule
request.
Submit a CreateRule
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateRule 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 \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#CreateRuleGroup": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#CreateRuleGroupRequest" }, "output": { "target": "com.amazonaws.wafregional#CreateRuleGroupResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFBadRequestException" }, { "target": "com.amazonaws.wafregional#WAFDisallowedNameException" }, { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFLimitsExceededException" }, { "target": "com.amazonaws.wafregional#WAFStaleDataException" }, { "target": "com.amazonaws.wafregional#WAFTagOperationException" }, { "target": "com.amazonaws.wafregional#WAFTagOperationInternalErrorException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nCreates a RuleGroup
. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.
Rule groups are subject to the following limits:
\n\tThree rule groups per account. You can request an increase to this limit by contacting customer support.
\nOne rule group per web ACL.
\nTen rules per rule group.
\nFor more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n AWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#CreateRuleGroupRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { "smithy.api#documentation": "A friendly name or description of the RuleGroup. You can't change Name
after you create a \n RuleGroup
.
A friendly name or description for the metrics for this RuleGroup
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup
.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.wafregional#TagList", "traits": { "smithy.api#documentation": "" } } } }, "com.amazonaws.wafregional#CreateRuleGroupResponse": { "type": "structure", "members": { "RuleGroup": { "target": "com.amazonaws.wafregional#RuleGroup", "traits": { "smithy.api#documentation": "An empty RuleGroup.
" } }, "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the CreateRuleGroup
request. You can also use this value \n to query the status of the request. For more information, see GetChangeTokenStatus.
A friendly name or description of the Rule. You can't change the name of a Rule
after you create it.
A friendly name or description for the metrics for this Rule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n\t whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the\n Rule
.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.wafregional#TagList", "traits": { "smithy.api#documentation": "" } } } }, "com.amazonaws.wafregional#CreateRuleResponse": { "type": "structure", "members": { "Rule": { "target": "com.amazonaws.wafregional#Rule", "traits": { "smithy.api#documentation": "The Rule returned in the CreateRule
response.
The ChangeToken
that you used to submit the CreateRule
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nCreates a SizeConstraintSet
. You then use UpdateSizeConstraintSet to identify the part of a \n\t\t\tweb 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. \n\t\t\tFor example, you can create a SizeConstraintSet
that matches any requests that have a query string that is longer than 100 bytes. \n\t\t\tYou 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 \n\t\t\t\tCreateSizeConstraintSet
request.
Submit a CreateSizeConstraintSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateSizeConstraintSet
request.
Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect \n\t\t\t\t(for example, the header or the URI) and the value that you want AWS WAF to watch for.
\nFor more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#CreateSizeConstraintSetRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { "smithy.api#documentation": "A friendly name or description of the SizeConstraintSet. You can't change Name
after you create a \n\t\t\tSizeConstraintSet
.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#CreateSizeConstraintSetResponse": { "type": "structure", "members": { "SizeConstraintSet": { "target": "com.amazonaws.wafregional#SizeConstraintSet", "traits": { "smithy.api#documentation": "A SizeConstraintSet that contains no SizeConstraint
objects.
The ChangeToken
that you used to submit the CreateSizeConstraintSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nCreates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a \n\t\t\tspecified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
\n\t\tTo 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 \n\t\t\t\tCreateSqlInjectionMatchSet
request.
Submit a CreateSqlInjectionMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateSqlInjectionMatchSet request.
Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to \n\t\t\t\tallow, block, or count malicious SQL code.
\nFor more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#CreateSqlInjectionMatchSetRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { "smithy.api#documentation": "A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name
\n\t\t\tafter you create the SqlInjectionMatchSet
.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A request to create a SqlInjectionMatchSet.
" } }, "com.amazonaws.wafregional#CreateSqlInjectionMatchSetResponse": { "type": "structure", "members": { "SqlInjectionMatchSet": { "target": "com.amazonaws.wafregional#SqlInjectionMatchSet", "traits": { "smithy.api#documentation": "" } }, "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the CreateSqlInjectionMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
The response to a CreateSqlInjectionMatchSet
request.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nCreates a WebACL
, which contains the Rules
that identify the CloudFront web requests that you want to allow, block, or count. \n\t\t\tAWS 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 \n\t\t\tany 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
. \n\t\t\t\tFor more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, \n\t\t\t\tCreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules
that you want to include in the WebACL
. For more information, see \n\t\t\t\tCreateRule and UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a \n\t\t\t\tCreateWebACL
request.
Submit a CreateWebACL
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateWebACL request.
Submit an UpdateWebACL request to specify the Rules
that you want to include in the WebACL
, \n\t\t\t\tto 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.
" } }, "com.amazonaws.wafregional#CreateWebACLMigrationStack": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#CreateWebACLMigrationStackRequest" }, "output": { "target": "com.amazonaws.wafregional#CreateWebACLMigrationStackResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFEntityMigrationException" }, { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidOperationException" }, { "target": "com.amazonaws.wafregional#WAFInvalidParameterException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" } ], "traits": { "smithy.api#documentation": "Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. \n Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. \n Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.
\nThis is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. \n For the full procedure, including caveats and manual steps to complete \n the migration and switch over to the new web ACL, see \n Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF \n Developer Guide.
" } }, "com.amazonaws.wafregional#CreateWebACLMigrationStackRequest": { "type": "structure", "members": { "WebACLId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.
", "smithy.api#required": {} } }, "S3BucketName": { "target": "com.amazonaws.wafregional#S3BucketName", "traits": { "smithy.api#documentation": "The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 bucket must be \n configured as follows for the migration:
\nThe bucket name must start with aws-waf-migration-
. For example, aws-waf-migration-my-web-acl
.
The bucket must be in the Region where you are deploying the template. For example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template stack to us-west-2.
\nThe bucket policies must permit the migration process to write data. For listings of the \n bucket policies, see the Examples section.
\nIndicates whether to exclude entities that can't be migrated or to stop the migration.\n Set this to true to ignore unsupported entities in the web ACL during the migration. Otherwise, if AWS WAF encounters unsupported \n entities, it stops the process and throws an exception.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#CreateWebACLMigrationStackResponse": { "type": "structure", "members": { "S3ObjectUrl": { "target": "com.amazonaws.wafregional#S3ObjectUrl", "traits": { "smithy.api#documentation": "The URL of the template created in Amazon S3.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#CreateWebACLRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { "smithy.api#documentation": "A friendly name or description of the WebACL. You can't change Name
after you create the WebACL
.
A friendly name or description for the metrics for this WebACL
.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n\t whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName
after you create the\n WebACL
.
The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule
\n\t\t\tobjects that are associated with the WebACL
.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.wafregional#TagList", "traits": { "smithy.api#documentation": "" } } } }, "com.amazonaws.wafregional#CreateWebACLResponse": { "type": "structure", "members": { "WebACL": { "target": "com.amazonaws.wafregional#WebACL", "traits": { "smithy.api#documentation": "The WebACL returned in the CreateWebACL
response.
The ChangeToken
that you used to submit the CreateWebACL
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nCreates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks\n\t\t\tin the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
\n\t\tTo 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 \n\t\t\t\tCreateXssMatchSet
request.
Submit a CreateXssMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateXssMatchSet request.
Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to \n\t\t\t\tallow, block, or count cross-site scripting attacks.
\nFor more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#CreateXssMatchSetRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { "smithy.api#documentation": "A friendly name or description for the XssMatchSet that you're creating. You can't change Name
\n\t\t\tafter you create the XssMatchSet
.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A request to create an XssMatchSet.
" } }, "com.amazonaws.wafregional#CreateXssMatchSetResponse": { "type": "structure", "members": { "XssMatchSet": { "target": "com.amazonaws.wafregional#XssMatchSet", "traits": { "smithy.api#documentation": "An XssMatchSet.
" } }, "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the CreateXssMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
The response to a CreateXssMatchSet
request.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes a ByteMatchSet. You can't delete a ByteMatchSet
if it's still used in any Rules
\n\t\t\tor 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 \n\t\t\t\tDeleteByteMatchSet
request.
Submit a DeleteByteMatchSet
request.
The ByteMatchSetId
of the ByteMatchSet that you want to delete. ByteMatchSetId
is returned by CreateByteMatchSet and by \n\t\t\tListByteMatchSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#DeleteByteMatchSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the DeleteByteMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes a GeoMatchSet. You can't delete a GeoMatchSet
if it's still used in any Rules
or \n\t\t\tif it still includes any countries.
If you just want to remove a GeoMatchSet
from a Rule
, use UpdateRule.
To permanently delete a GeoMatchSet
from AWS WAF, perform the following steps:
Update the GeoMatchSet
to remove any countries. For more information, see UpdateGeoMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a \n\t\t\t\tDeleteGeoMatchSet
request.
Submit a DeleteGeoMatchSet
request.
The GeoMatchSetID
of the GeoMatchSet that you want to delete. GeoMatchSetId
is returned by CreateGeoMatchSet and by \n\t\t\tListGeoMatchSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#DeleteGeoMatchSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the DeleteGeoMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes an IPSet. You can't delete an IPSet
if it's still used in any Rules
or \n\t\t\tif 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 \n\t\t\t\tDeleteIPSet
request.
Submit a DeleteIPSet
request.
The IPSetId
of the IPSet that you want to delete. IPSetId
is returned by CreateIPSet and by \n\t\t\tListIPSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#DeleteIPSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the DeleteIPSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes the LoggingConfiguration from the specified web\n ACL.
" } }, "com.amazonaws.wafregional#DeleteLoggingConfigurationRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#DeleteLoggingConfigurationResponse": { "type": "structure", "members": {} }, "com.amazonaws.wafregional#DeletePermissionPolicy": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#DeletePermissionPolicyRequest" }, "output": { "target": "com.amazonaws.wafregional#DeletePermissionPolicyResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" }, { "target": "com.amazonaws.wafregional#WAFStaleDataException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes an IAM policy from the specified RuleGroup.
\nThe user making the request must be the owner of the RuleGroup.
" } }, "com.amazonaws.wafregional#DeletePermissionPolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy.
\nThe user making the request must be the owner of the RuleGroup.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#DeletePermissionPolicyResponse": { "type": "structure", "members": {} }, "com.amazonaws.wafregional#DeleteRateBasedRule": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#DeleteRateBasedRuleRequest" }, "output": { "target": "com.amazonaws.wafregional#DeleteRateBasedRuleResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" }, { "target": "com.amazonaws.wafregional#WAFNonEmptyEntityException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" }, { "target": "com.amazonaws.wafregional#WAFReferencedItemException" }, { "target": "com.amazonaws.wafregional#WAFStaleDataException" }, { "target": "com.amazonaws.wafregional#WAFTagOperationException" }, { "target": "com.amazonaws.wafregional#WAFTagOperationInternalErrorException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes a RateBasedRule. You can't delete a rule if\n it's still used in any WebACL
objects or if it still includes any predicates,\n such as ByteMatchSet
objects.
If you just want to remove a rule from a WebACL
, use UpdateWebACL.
To permanently delete a RateBasedRule
from AWS WAF, perform the following\n steps:
Update the RateBasedRule
to remove predicates, if any. For more\n information, see UpdateRateBasedRule.
Use GetChangeToken to get the change token that you provide\n in the ChangeToken
parameter of a DeleteRateBasedRule
\n request.
Submit a DeleteRateBasedRule
request.
The RuleId
of the RateBasedRule that you want to\n delete. RuleId
is returned by CreateRateBasedRule and by\n ListRateBasedRules.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#DeleteRateBasedRuleResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the\n DeleteRateBasedRule
request. You can also use this value to query the\n status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes a RegexMatchSet. You can't delete a RegexMatchSet
if it's still used in any Rules
\n or if it still includes any RegexMatchTuples
objects (any filters).
If you just want to remove a RegexMatchSet
from a Rule
, use UpdateRule.
To permanently delete a RegexMatchSet
, perform the following steps:
Update the RegexMatchSet
to remove filters, if any. For more information, see UpdateRegexMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a \n\t\t\t\tDeleteRegexMatchSet
request.
Submit a DeleteRegexMatchSet
request.
The RegexMatchSetId
of the RegexMatchSet that you want to delete. RegexMatchSetId
is returned by CreateRegexMatchSet and by \n\t\t\tListRegexMatchSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#DeleteRegexMatchSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the DeleteRegexMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes a RegexPatternSet. You can't delete a RegexPatternSet
if it's still used in any RegexMatchSet
\n or if the RegexPatternSet
is not empty.
The RegexPatternSetId
of the RegexPatternSet that you want to delete. RegexPatternSetId
is returned by CreateRegexPatternSet and by \n\t\t\tListRegexPatternSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#DeleteRegexPatternSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the DeleteRegexPatternSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes a Rule. You can't delete a Rule
if it's still used in any WebACL
\n\t\t\tobjects 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 \n\t\t\t\tDeleteRule
request.
Submit a DeleteRule
request.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes a RuleGroup. You can't delete a RuleGroup
if it's still used in any WebACL
\n objects or if it still includes any rules.
If you just want to remove a RuleGroup
from a WebACL
, use UpdateWebACL.
To permanently delete a RuleGroup
from AWS WAF, perform the following steps:
Update the RuleGroup
to remove rules, if any. For more information, see UpdateRuleGroup.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a \n DeleteRuleGroup
request.
Submit a DeleteRuleGroup
request.
The RuleGroupId
of the RuleGroup that you want to delete. RuleGroupId
is returned by CreateRuleGroup and by \n ListRuleGroups.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#DeleteRuleGroupResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the DeleteRuleGroup
request. You can also use this value \n to query the status of the request. For more information, see GetChangeTokenStatus.
The RuleId
of the Rule that you want to delete. RuleId
is returned by CreateRule and by \n\t\t\tListRules.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#DeleteRuleResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the DeleteRule
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet
if it's still used in any Rules
\n\t\t\tor 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 \n\t\t\t\tDeleteSizeConstraintSet
request.
Submit a DeleteSizeConstraintSet
request.
The SizeConstraintSetId
of the SizeConstraintSet that you want to delete. SizeConstraintSetId
\n\t\t\tis returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#DeleteSizeConstraintSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the DeleteSizeConstraintSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet
if it's \n\t\t\tstill 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 \n\t\t\t\tUpdateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a \n\t\t\t\tDeleteSqlInjectionMatchSet
request.
Submit a DeleteSqlInjectionMatchSet
request.
The SqlInjectionMatchSetId
of the SqlInjectionMatchSet that you want to delete. \n\t\t\tSqlInjectionMatchSetId
is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A request to delete a SqlInjectionMatchSet from AWS WAF.
" } }, "com.amazonaws.wafregional#DeleteSqlInjectionMatchSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the DeleteSqlInjectionMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
The response to a request to delete a SqlInjectionMatchSet from AWS WAF.
" } }, "com.amazonaws.wafregional#DeleteWebACL": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#DeleteWebACLRequest" }, "output": { "target": "com.amazonaws.wafregional#DeleteWebACLResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" }, { "target": "com.amazonaws.wafregional#WAFNonEmptyEntityException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" }, { "target": "com.amazonaws.wafregional#WAFReferencedItemException" }, { "target": "com.amazonaws.wafregional#WAFStaleDataException" }, { "target": "com.amazonaws.wafregional#WAFTagOperationException" }, { "target": "com.amazonaws.wafregional#WAFTagOperationInternalErrorException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently 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 \n\t\t\t\tDeleteWebACL
request.
Submit a DeleteWebACL
request.
The WebACLId
of the WebACL that you want to delete. WebACLId
is returned by CreateWebACL and by \n\t\t\tListWebACLs.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#DeleteWebACLResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the DeleteWebACL
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nPermanently deletes an XssMatchSet. You can't delete an XssMatchSet
if it's \n\t\t\tstill 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 \n\t\t\t\tUpdateXssMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a \n\t\t\t\tDeleteXssMatchSet
request.
Submit a DeleteXssMatchSet
request.
The XssMatchSetId
of the XssMatchSet that you want to delete. \n\t\t\tXssMatchSetId
is returned by CreateXssMatchSet and by ListXssMatchSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A request to delete an XssMatchSet from AWS WAF.
" } }, "com.amazonaws.wafregional#DeleteXssMatchSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the DeleteXssMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
The response to a request to delete an XssMatchSet from AWS WAF.
" } }, "com.amazonaws.wafregional#DisassociateWebACL": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#DisassociateWebACLRequest" }, "output": { "target": "com.amazonaws.wafregional#DisassociateWebACLResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" }, { "target": "com.amazonaws.wafregional#WAFInvalidParameterException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic Regional documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nRemoves a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage.
" } }, "com.amazonaws.wafregional#DisassociateWebACLRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed, either an application load balancer or Amazon API Gateway stage.
\nThe ARN should be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n
\n
For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n
\n
The unique identifier for the rule to exclude from the rule group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe rule to exclude from a rule group. This is applicable only when the\n ActivatedRule
refers to a RuleGroup
. The rule must belong to\n the RuleGroup
that is specified by the ActivatedRule
.
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:
\n\t\t\n HEADER
: A specified request header, for example, the value of the User-Agent
or Referer
header. \n\t\t\t\tIf you choose HEADER
for the type, specify the name of the header in Data
.
\n METHOD
: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. \n\t\t\t\tAmazon CloudFront supports the following methods: DELETE
, GET
, HEAD
, OPTIONS
, PATCH
, \n\t\t\t\tPOST
, and PUT
.
\n QUERY_STRING
: A query string, which is the part of a URL that appears after a ?
character, if any.
\n URI
: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg
.
\n BODY
: The part of a request that contains any additional data that you want to send to your web server \n\t\t\t\tas the HTTP request body, such as data from a form. The request body immediately follows the request headers. \n\t\t\t\tNote that only the first 8192
bytes of the request body are forwarded to AWS WAF for inspection. \n\t\t\t\tTo allow or block requests based on the length of the body, you can create a size constraint set. \n\t\t\t\tFor more information, see CreateSizeConstraintSet.
\n\t\t SINGLE_QUERY_ARG
: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG
is 30 characters.
\n\t\t ALL_QUERY_ARGS
: Similar to SINGLE_QUERY_ARG
, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in \n\t\t TargetString
.
When the value of Type
is HEADER
, enter the name of the header that you want AWS WAF to search, \n\t\t\tfor example, User-Agent
or Referer
. The name of the header is not case sensitive.
When the value of Type
is SINGLE_QUERY_ARG
, enter the name of the parameter that you want AWS WAF to search, \n\t for example, UserName
or SalesRegion
. The parameter name is not case sensitive.
If the value of Type
is any other value, omit Data
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies where in a web request to look for TargetString
.
The type of geographical area you want AWS WAF to search for. Currently Country
is the only valid value.
The country that you want AWS WAF to search for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe country from which web requests originate that you want AWS WAF to search for.
" } }, "com.amazonaws.wafregional#GeoMatchConstraintType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Country", "name": "Country" } ] } }, "com.amazonaws.wafregional#GeoMatchConstraintValue": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AF", "name": "AF" }, { "value": "AX", "name": "AX" }, { "value": "AL", "name": "AL" }, { "value": "DZ", "name": "DZ" }, { "value": "AS", "name": "AS" }, { "value": "AD", "name": "AD" }, { "value": "AO", "name": "AO" }, { "value": "AI", "name": "AI" }, { "value": "AQ", "name": "AQ" }, { "value": "AG", "name": "AG" }, { "value": "AR", "name": "AR" }, { "value": "AM", "name": "AM" }, { "value": "AW", "name": "AW" }, { "value": "AU", "name": "AU" }, { "value": "AT", "name": "AT" }, { "value": "AZ", "name": "AZ" }, { "value": "BS", "name": "BS" }, { "value": "BH", "name": "BH" }, { "value": "BD", "name": "BD" }, { "value": "BB", "name": "BB" }, { "value": "BY", "name": "BY" }, { "value": "BE", "name": "BE" }, { "value": "BZ", "name": "BZ" }, { "value": "BJ", "name": "BJ" }, { "value": "BM", "name": "BM" }, { "value": "BT", "name": "BT" }, { "value": "BO", "name": "BO" }, { "value": "BQ", "name": "BQ" }, { "value": "BA", "name": "BA" }, { "value": "BW", "name": "BW" }, { "value": "BV", "name": "BV" }, { "value": "BR", "name": "BR" }, { "value": "IO", "name": "IO" }, { "value": "BN", "name": "BN" }, { "value": "BG", "name": "BG" }, { "value": "BF", "name": "BF" }, { "value": "BI", "name": "BI" }, { "value": "KH", "name": "KH" }, { "value": "CM", "name": "CM" }, { "value": "CA", "name": "CA" }, { "value": "CV", "name": "CV" }, { "value": "KY", "name": "KY" }, { "value": "CF", "name": "CF" }, { "value": "TD", "name": "TD" }, { "value": "CL", "name": "CL" }, { "value": "CN", "name": "CN" }, { "value": "CX", "name": "CX" }, { "value": "CC", "name": "CC" }, { "value": "CO", "name": "CO" }, { "value": "KM", "name": "KM" }, { "value": "CG", "name": "CG" }, { "value": "CD", "name": "CD" }, { "value": "CK", "name": "CK" }, { "value": "CR", "name": "CR" }, { "value": "CI", "name": "CI" }, { "value": "HR", "name": "HR" }, { "value": "CU", "name": "CU" }, { "value": "CW", "name": "CW" }, { "value": "CY", "name": "CY" }, { "value": "CZ", "name": "CZ" }, { "value": "DK", "name": "DK" }, { "value": "DJ", "name": "DJ" }, { "value": "DM", "name": "DM" }, { "value": "DO", "name": "DO" }, { "value": "EC", "name": "EC" }, { "value": "EG", "name": "EG" }, { "value": "SV", "name": "SV" }, { "value": "GQ", "name": "GQ" }, { "value": "ER", "name": "ER" }, { "value": "EE", "name": "EE" }, { "value": "ET", "name": "ET" }, { "value": "FK", "name": "FK" }, { "value": "FO", "name": "FO" }, { "value": "FJ", "name": "FJ" }, { "value": "FI", "name": "FI" }, { "value": "FR", "name": "FR" }, { "value": "GF", "name": "GF" }, { "value": "PF", "name": "PF" }, { "value": "TF", "name": "TF" }, { "value": "GA", "name": "GA" }, { "value": "GM", "name": "GM" }, { "value": "GE", "name": "GE" }, { "value": "DE", "name": "DE" }, { "value": "GH", "name": "GH" }, { "value": "GI", "name": "GI" }, { "value": "GR", "name": "GR" }, { "value": "GL", "name": "GL" }, { "value": "GD", "name": "GD" }, { "value": "GP", "name": "GP" }, { "value": "GU", "name": "GU" }, { "value": "GT", "name": "GT" }, { "value": "GG", "name": "GG" }, { "value": "GN", "name": "GN" }, { "value": "GW", "name": "GW" }, { "value": "GY", "name": "GY" }, { "value": "HT", "name": "HT" }, { "value": "HM", "name": "HM" }, { "value": "VA", "name": "VA" }, { "value": "HN", "name": "HN" }, { "value": "HK", "name": "HK" }, { "value": "HU", "name": "HU" }, { "value": "IS", "name": "IS" }, { "value": "IN", "name": "IN" }, { "value": "ID", "name": "ID" }, { "value": "IR", "name": "IR" }, { "value": "IQ", "name": "IQ" }, { "value": "IE", "name": "IE" }, { "value": "IM", "name": "IM" }, { "value": "IL", "name": "IL" }, { "value": "IT", "name": "IT" }, { "value": "JM", "name": "JM" }, { "value": "JP", "name": "JP" }, { "value": "JE", "name": "JE" }, { "value": "JO", "name": "JO" }, { "value": "KZ", "name": "KZ" }, { "value": "KE", "name": "KE" }, { "value": "KI", "name": "KI" }, { "value": "KP", "name": "KP" }, { "value": "KR", "name": "KR" }, { "value": "KW", "name": "KW" }, { "value": "KG", "name": "KG" }, { "value": "LA", "name": "LA" }, { "value": "LV", "name": "LV" }, { "value": "LB", "name": "LB" }, { "value": "LS", "name": "LS" }, { "value": "LR", "name": "LR" }, { "value": "LY", "name": "LY" }, { "value": "LI", "name": "LI" }, { "value": "LT", "name": "LT" }, { "value": "LU", "name": "LU" }, { "value": "MO", "name": "MO" }, { "value": "MK", "name": "MK" }, { "value": "MG", "name": "MG" }, { "value": "MW", "name": "MW" }, { "value": "MY", "name": "MY" }, { "value": "MV", "name": "MV" }, { "value": "ML", "name": "ML" }, { "value": "MT", "name": "MT" }, { "value": "MH", "name": "MH" }, { "value": "MQ", "name": "MQ" }, { "value": "MR", "name": "MR" }, { "value": "MU", "name": "MU" }, { "value": "YT", "name": "YT" }, { "value": "MX", "name": "MX" }, { "value": "FM", "name": "FM" }, { "value": "MD", "name": "MD" }, { "value": "MC", "name": "MC" }, { "value": "MN", "name": "MN" }, { "value": "ME", "name": "ME" }, { "value": "MS", "name": "MS" }, { "value": "MA", "name": "MA" }, { "value": "MZ", "name": "MZ" }, { "value": "MM", "name": "MM" }, { "value": "NA", "name": "NA" }, { "value": "NR", "name": "NR" }, { "value": "NP", "name": "NP" }, { "value": "NL", "name": "NL" }, { "value": "NC", "name": "NC" }, { "value": "NZ", "name": "NZ" }, { "value": "NI", "name": "NI" }, { "value": "NE", "name": "NE" }, { "value": "NG", "name": "NG" }, { "value": "NU", "name": "NU" }, { "value": "NF", "name": "NF" }, { "value": "MP", "name": "MP" }, { "value": "NO", "name": "NO" }, { "value": "OM", "name": "OM" }, { "value": "PK", "name": "PK" }, { "value": "PW", "name": "PW" }, { "value": "PS", "name": "PS" }, { "value": "PA", "name": "PA" }, { "value": "PG", "name": "PG" }, { "value": "PY", "name": "PY" }, { "value": "PE", "name": "PE" }, { "value": "PH", "name": "PH" }, { "value": "PN", "name": "PN" }, { "value": "PL", "name": "PL" }, { "value": "PT", "name": "PT" }, { "value": "PR", "name": "PR" }, { "value": "QA", "name": "QA" }, { "value": "RE", "name": "RE" }, { "value": "RO", "name": "RO" }, { "value": "RU", "name": "RU" }, { "value": "RW", "name": "RW" }, { "value": "BL", "name": "BL" }, { "value": "SH", "name": "SH" }, { "value": "KN", "name": "KN" }, { "value": "LC", "name": "LC" }, { "value": "MF", "name": "MF" }, { "value": "PM", "name": "PM" }, { "value": "VC", "name": "VC" }, { "value": "WS", "name": "WS" }, { "value": "SM", "name": "SM" }, { "value": "ST", "name": "ST" }, { "value": "SA", "name": "SA" }, { "value": "SN", "name": "SN" }, { "value": "RS", "name": "RS" }, { "value": "SC", "name": "SC" }, { "value": "SL", "name": "SL" }, { "value": "SG", "name": "SG" }, { "value": "SX", "name": "SX" }, { "value": "SK", "name": "SK" }, { "value": "SI", "name": "SI" }, { "value": "SB", "name": "SB" }, { "value": "SO", "name": "SO" }, { "value": "ZA", "name": "ZA" }, { "value": "GS", "name": "GS" }, { "value": "SS", "name": "SS" }, { "value": "ES", "name": "ES" }, { "value": "LK", "name": "LK" }, { "value": "SD", "name": "SD" }, { "value": "SR", "name": "SR" }, { "value": "SJ", "name": "SJ" }, { "value": "SZ", "name": "SZ" }, { "value": "SE", "name": "SE" }, { "value": "CH", "name": "CH" }, { "value": "SY", "name": "SY" }, { "value": "TW", "name": "TW" }, { "value": "TJ", "name": "TJ" }, { "value": "TZ", "name": "TZ" }, { "value": "TH", "name": "TH" }, { "value": "TL", "name": "TL" }, { "value": "TG", "name": "TG" }, { "value": "TK", "name": "TK" }, { "value": "TO", "name": "TO" }, { "value": "TT", "name": "TT" }, { "value": "TN", "name": "TN" }, { "value": "TR", "name": "TR" }, { "value": "TM", "name": "TM" }, { "value": "TC", "name": "TC" }, { "value": "TV", "name": "TV" }, { "value": "UG", "name": "UG" }, { "value": "UA", "name": "UA" }, { "value": "AE", "name": "AE" }, { "value": "GB", "name": "GB" }, { "value": "US", "name": "US" }, { "value": "UM", "name": "UM" }, { "value": "UY", "name": "UY" }, { "value": "UZ", "name": "UZ" }, { "value": "VU", "name": "VU" }, { "value": "VE", "name": "VE" }, { "value": "VN", "name": "VN" }, { "value": "VG", "name": "VG" }, { "value": "VI", "name": "VI" }, { "value": "WF", "name": "WF" }, { "value": "EH", "name": "EH" }, { "value": "YE", "name": "YE" }, { "value": "ZM", "name": "ZM" }, { "value": "ZW", "name": "ZW" } ] } }, "com.amazonaws.wafregional#GeoMatchConstraints": { "type": "list", "member": { "target": "com.amazonaws.wafregional#GeoMatchConstraint" } }, "com.amazonaws.wafregional#GeoMatchSet": { "type": "structure", "members": { "GeoMatchSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The GeoMatchSetId
for an GeoMatchSet
. You use GeoMatchSetId
to get information about a \n\t\t\tGeoMatchSet
(see GeoMatchSet), update a GeoMatchSet
(see UpdateGeoMatchSet), insert a GeoMatchSet
into a Rule
or delete one from a Rule
(see UpdateRule), and delete a GeoMatchSet
from AWS WAF (see DeleteGeoMatchSet).
\n GeoMatchSetId
is returned by CreateGeoMatchSet and by ListGeoMatchSets.
A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet
after you create it.
An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nContains one or more countries that AWS WAF will search for.
" } }, "com.amazonaws.wafregional#GeoMatchSetSummaries": { "type": "list", "member": { "target": "com.amazonaws.wafregional#GeoMatchSetSummary" } }, "com.amazonaws.wafregional#GeoMatchSetSummary": { "type": "structure", "members": { "GeoMatchSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The GeoMatchSetId
for an GeoMatchSet. You can use GeoMatchSetId
in a GetGeoMatchSet request to get detailed\tinformation about an GeoMatchSet.
A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet
after you create it.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nContains the identifier and the name of the GeoMatchSet
.
Specifies whether to insert or delete a country with UpdateGeoMatchSet.
", "smithy.api#required": {} } }, "GeoMatchConstraint": { "target": "com.amazonaws.wafregional#GeoMatchConstraint", "traits": { "smithy.api#documentation": "The country from which web requests originate that you want AWS WAF to search for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies the type of update to perform to an GeoMatchSet with UpdateGeoMatchSet.
" } }, "com.amazonaws.wafregional#GeoMatchSetUpdates": { "type": "list", "member": { "target": "com.amazonaws.wafregional#GeoMatchSetUpdate" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.wafregional#GetByteMatchSet": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#GetByteMatchSetRequest" }, "output": { "target": "com.amazonaws.wafregional#GetByteMatchSetResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the ByteMatchSet specified by ByteMatchSetId
.
The ByteMatchSetId
of the ByteMatchSet that you want to get. ByteMatchSetId
is returned by \n\t\t\tCreateByteMatchSet and by ListByteMatchSets.
Information about the ByteMatchSet that you specified in the GetByteMatchSet
request. For more information, see the \n\t\t\tfollowing topics:
\n ByteMatchSet: Contains ByteMatchSetId
, ByteMatchTuples
, and Name
\n
\n ByteMatchTuples
: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple
\n\t\t\t\tobject contains FieldToMatch, PositionalConstraint
, TargetString
, \n\t\t\t\tand TextTransformation
\n
\n FieldToMatch: Contains Data
and Type
\n
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nWhen 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.
\n\t\tEach create, update, or delete request must use a unique change token. If your application submits a GetChangeToken
request \n\t\t\tand then submits a second GetChangeToken
request before submitting a create, update, or delete request, the second \n\t\t\tGetChangeToken
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
, \n\t\t\twhich indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus
to determine the \n\t\t\tstatus of your change token.
The ChangeToken
that you used in the request. Use this value in a GetChangeTokenStatus
request \n\t\t\tto get the current status of the request.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the status of a ChangeToken
that you got by calling GetChangeToken. ChangeTokenStatus
is \n\t\t\tone of the following values:
\n PROVISIONED
: You requested the change token by calling GetChangeToken
, but you haven't used it yet \n\t\t\t\tin a call to create, update, or delete an AWS WAF object.
\n PENDING
: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.
\n INSYNC
: Propagation is complete.
The change token for which you want to get the status. This change token was previously returned in the GetChangeToken
response.
The status of the change token.
" } } } }, "com.amazonaws.wafregional#GetGeoMatchSet": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#GetGeoMatchSetRequest" }, "output": { "target": "com.amazonaws.wafregional#GetGeoMatchSetResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the GeoMatchSet that is specified by GeoMatchSetId
.
The GeoMatchSetId
of the GeoMatchSet that you want to get. GeoMatchSetId
is returned by CreateGeoMatchSet and by \n\t\t\tListGeoMatchSets.
Information about the GeoMatchSet that you specified in the GetGeoMatchSet
request. This includes the Type
, which for a GeoMatchContraint
is always Country
, as well as the Value
, which is the identifier for a specific country.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the IPSet that is specified by IPSetId
.
The IPSetId
of the IPSet that you want to get. IPSetId
is returned by CreateIPSet and by \n\t\t\tListIPSets.
Information about the IPSet that you specified in the GetIPSet
request. For more information, see the \n\t\t\tfollowing topics:
\n IPSet: Contains IPSetDescriptors
, IPSetId
, and Name
\n
\n IPSetDescriptors
: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor
\n\t\t\t\tobject contains Type
and Value
\n
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the LoggingConfiguration for the specified web ACL.
" } }, "com.amazonaws.wafregional#GetLoggingConfigurationRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#GetLoggingConfigurationResponse": { "type": "structure", "members": { "LoggingConfiguration": { "target": "com.amazonaws.wafregional#LoggingConfiguration", "traits": { "smithy.api#documentation": "The LoggingConfiguration for the specified web ACL.
" } } } }, "com.amazonaws.wafregional#GetPermissionPolicy": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#GetPermissionPolicyRequest" }, "output": { "target": "com.amazonaws.wafregional#GetPermissionPolicyResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the IAM policy attached to the RuleGroup.
" } }, "com.amazonaws.wafregional#GetPermissionPolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#GetPermissionPolicyResponse": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.wafregional#PolicyString", "traits": { "smithy.api#documentation": "The IAM policy attached to the specified RuleGroup.
" } } } }, "com.amazonaws.wafregional#GetRateBasedRule": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#GetRateBasedRuleRequest" }, "output": { "target": "com.amazonaws.wafregional#GetRateBasedRuleResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the RateBasedRule that is specified by the\n RuleId
that you included in the GetRateBasedRule
\n request.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId
. The maximum\n number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed\n the rate limit, the 10,000 addresses with the highest rates will be blocked.
The RuleId
of the RateBasedRule for which you want to\n get a list of ManagedKeys
. RuleId
is returned by CreateRateBasedRule and by ListRateBasedRules.
A null value and not currently used. Do not include this in your request.
" } } } }, "com.amazonaws.wafregional#GetRateBasedRuleManagedKeysResponse": { "type": "structure", "members": { "ManagedKeys": { "target": "com.amazonaws.wafregional#ManagedKeys", "traits": { "smithy.api#documentation": "An array of IP addresses that currently are blocked by the specified RateBasedRule.
" } }, "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "A null value and not currently used.
" } } } }, "com.amazonaws.wafregional#GetRateBasedRuleRequest": { "type": "structure", "members": { "RuleId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The RuleId
of the RateBasedRule that you want to get.\n RuleId
is returned by CreateRateBasedRule and by ListRateBasedRules.
Information about the RateBasedRule that you specified in the\n GetRateBasedRule
request.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the RegexMatchSet specified by RegexMatchSetId
.
The RegexMatchSetId
of the RegexMatchSet that you want to get. RegexMatchSetId
is returned by \n\t\t\tCreateRegexMatchSet and by ListRegexMatchSets.
Information about the RegexMatchSet that you specified in the GetRegexMatchSet
request. For more information, see RegexMatchTuple.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the RegexPatternSet specified by RegexPatternSetId
.
The RegexPatternSetId
of the RegexPatternSet that you want to get. RegexPatternSetId
is returned by \n\t\t\tCreateRegexPatternSet and by ListRegexPatternSets.
Information about the RegexPatternSet that you specified in the GetRegexPatternSet
request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the Rule that is specified by the RuleId
that you included in the GetRule
request.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the RuleGroup that is specified by the RuleGroupId
that you included in the GetRuleGroup
request.
To view the rules in a rule group, use ListActivatedRulesInRuleGroup.
" } }, "com.amazonaws.wafregional#GetRuleGroupRequest": { "type": "structure", "members": { "RuleGroupId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The RuleGroupId
of the RuleGroup that you want to get. RuleGroupId
is returned by CreateRuleGroup and by \n ListRuleGroups.
Information about the RuleGroup that you specified in the GetRuleGroup
request.
The RuleId
of the Rule that you want to get. RuleId
is returned by CreateRule and by \n\t\t\tListRules.
Information about the Rule that you specified in the GetRule
request. \n\t\t\tFor more information, see the following topics:
\n Rule: Contains MetricName
, Name
, an array of Predicate
objects, \n\t\t\t\tand RuleId
\n
\n Predicate: Each Predicate
object contains DataId
, Negated
, and \n\t\t\t\tType
\n
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nGets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.
\n\t\t\n GetSampledRequests
returns a time range, which is usually the time range that you specified. However, if your resource \n\t\t\t(such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests
\n\t\t\treturns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.
The WebACLId
of the WebACL
for which you want GetSampledRequests
to return a sample of requests.
\n RuleId
is one of three values:
The RuleId
of the Rule
or the RuleGroupId
of the RuleGroup
for which you want GetSampledRequests
to return a sample of requests.
\n Default_Action
, which causes GetSampledRequests
to return a sample of the requests that \n\t\t\t\t\tdidn't match any of the rules in the specified WebACL
.
The start date and time and the end date and time of the range for which you want GetSampledRequests
to return a \n sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special \n designator, Z
. For example, \"2016-09-27T14:50Z\"
. You can specify any time range in the previous three hours.
The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received\n\t\t\tduring the time range. If your resource received fewer requests than the value of MaxItems
, GetSampledRequests
\n\t\t\treturns information about all of them.
A complex type that contains detailed information about each of the requests in the sample.
" } }, "PopulationSize": { "target": "com.amazonaws.wafregional#PopulationSize", "traits": { "smithy.api#documentation": "The total number of requests from which GetSampledRequests
got a sample of MaxItems
requests. \n\t\t\tIf PopulationSize
is less than MaxItems
, the sample includes every request that your AWS resource \n\t\t\treceived during the specified time range.
Usually, TimeWindow
is the time range that you specified in the GetSampledRequests
request. However, \n\t\t\tif your AWS resource received more than 5,000 requests during the time range that you specified in the request, \n\t\t\tGetSampledRequests
returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the SizeConstraintSet specified by SizeConstraintSetId
.
The SizeConstraintSetId
of the SizeConstraintSet that you want to get. SizeConstraintSetId
is returned by \n\t\t\tCreateSizeConstraintSet and by ListSizeConstraintSets.
Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet
request. For more information, see the \n\t\t\tfollowing topics:
\n SizeConstraintSet: Contains SizeConstraintSetId
, SizeConstraints
, and Name
\n
\n SizeConstraints
: Contains an array of SizeConstraint objects. Each SizeConstraint
\n\t\t\t\tobject contains FieldToMatch, TextTransformation
, ComparisonOperator
, \n\t\t\t\tand Size
\n
\n FieldToMatch: Contains Data
and Type
\n
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId
.
The SqlInjectionMatchSetId
of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId
\n\t\t\tis returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
A request to get a SqlInjectionMatchSet.
" } }, "com.amazonaws.wafregional#GetSqlInjectionMatchSetResponse": { "type": "structure", "members": { "SqlInjectionMatchSet": { "target": "com.amazonaws.wafregional#SqlInjectionMatchSet", "traits": { "smithy.api#documentation": "Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet
request. \n\t\t\tFor more information, see the following topics:
\n SqlInjectionMatchSet: Contains Name
, SqlInjectionMatchSetId
, and an array of \n\t\t\t\tSqlInjectionMatchTuple
objects
\n SqlInjectionMatchTuple: Each SqlInjectionMatchTuple
object contains FieldToMatch
and \n\t\t\t\tTextTransformation
\n
\n FieldToMatch: Contains Data
and Type
\n
The response to a GetSqlInjectionMatchSet request.
" } }, "com.amazonaws.wafregional#GetWebACL": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#GetWebACLRequest" }, "output": { "target": "com.amazonaws.wafregional#GetWebACLResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the WebACL that is specified by WebACLId
.
This is AWS WAF Classic Regional documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage.
" } }, "com.amazonaws.wafregional#GetWebACLForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "The ARN (Amazon Resource Name) of the resource for which to get the web ACL, either an application load balancer or Amazon API Gateway stage.
\nThe ARN should be in one of the following formats:
\nFor an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n
\n
For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n
\n
Information about the web ACL that you specified in the GetWebACLForResource
request. If there is no associated resource, a null WebACLSummary is returned.
The WebACLId
of the WebACL that you want to get. WebACLId
is returned by CreateWebACL and by \n\t\t\tListWebACLs.
Information about the WebACL that you specified in the GetWebACL
request. \n\t\t\tFor more information, see the following topics:
\n WebACL: Contains DefaultAction
, MetricName
, Name
, an array of \n\t\t\t\tRule
objects, and WebACLId
\n
\n DefaultAction
(Data type is WafAction): Contains Type
\n
\n Rules
: Contains an array of ActivatedRule
objects, which contain Action
, \n\t\t\t\tPriority
, and RuleId
\n
\n Action
: Contains Type
\n
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns the XssMatchSet that is specified by XssMatchSetId
.
The XssMatchSetId
of the XssMatchSet that you want to get. XssMatchSetId
\n\t\t\tis returned by CreateXssMatchSet and by ListXssMatchSets.
A request to get an XssMatchSet.
" } }, "com.amazonaws.wafregional#GetXssMatchSetResponse": { "type": "structure", "members": { "XssMatchSet": { "target": "com.amazonaws.wafregional#XssMatchSet", "traits": { "smithy.api#documentation": "Information about the XssMatchSet that you specified in the GetXssMatchSet
request. \n\t\t\tFor more information, see the following topics:
\n XssMatchSet: Contains Name
, XssMatchSetId
, and an array of \n\t\t\t\tXssMatchTuple
objects
\n XssMatchTuple: Each XssMatchTuple
object contains FieldToMatch
and \n\t\t\t\tTextTransformation
\n
\n FieldToMatch: Contains Data
and Type
\n
The response to a GetXssMatchSet request.
" } }, "com.amazonaws.wafregional#HTTPHeader": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wafregional#HeaderName", "traits": { "smithy.api#documentation": "The name of one of the headers in the sampled web request.
" } }, "Value": { "target": "com.amazonaws.wafregional#HeaderValue", "traits": { "smithy.api#documentation": "The value of one of the headers in the sampled web request.
" } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe response from a GetSampledRequests request includes an HTTPHeader
complex type that \n\t\t\tappears as Headers
in the response syntax. HTTPHeader
contains the names and values of \n\t\t\tall of the headers that appear in one of the web requests that were returned by GetSampledRequests
.
The IP address that the request originated from. If the WebACL
is associated with a CloudFront distribution, \n\t\t\tthis is the value of one of the following fields in CloudFront access logs:
\n c-ip
, if the viewer did not use an HTTP proxy or a load balancer to send the request
\n x-forwarded-for
, if the viewer did use an HTTP proxy or a load balancer to send the request
The two-letter country code for the country that the request originated from. For a current list of country codes, \n\t\t\tsee the Wikipedia entry ISO 3166-1 alpha-2.
" } }, "URI": { "target": "com.amazonaws.wafregional#URIString", "traits": { "smithy.api#documentation": "The part of a web request that identifies the resource, for example, /images/daily-ad.jpg
.
The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE
, \n\t\t\tGET
, HEAD
, OPTIONS
, PATCH
, POST
, and PUT
.
The HTTP version specified in the sampled web request, for example, HTTP/1.1
.
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.
" } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe response from a GetSampledRequests request includes an HTTPRequest
complex type that \n\t\t\tappears as Request
in the response syntax. HTTPRequest
contains information about \n\t\t\tone of the web requests that were returned by GetSampledRequests
.
The IPSetId
for an IPSet
. You use IPSetId
to get information about an \n\t\t\tIPSet
(see GetIPSet), update an IPSet
(see UpdateIPSet), \n\t\t\tinsert an IPSet
into a Rule
or delete one from a Rule
(see UpdateRule), and \n\t\t\tdelete an IPSet
from AWS WAF (see DeleteIPSet).
\n IPSetId
is returned by CreateIPSet and by ListIPSets.
A friendly name or description of the IPSet. You can't change the name of an IPSet
after you create it.
The IP address type (IPV4
or IPV6
) and the IP address range (in CIDR notation) that web requests originate from. \n\t\t\tIf the WebACL
is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nContains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.
\n\tTo specify an individual IP address, you specify the four-part IP address followed by a\n /32
, for example, 192.0.2.0/32. To block a range of IP addresses, you can\n specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or\n /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.
Specify IPV4
or IPV6
.
Specify an IPv4 address by using CIDR notation. For example:
\n\t\tTo 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 \n\t\t\t\t192.0.2.0/24
.
For more information about CIDR notation, see the Wikipedia entry \n\t Classless Inter-Domain Routing.
\n\tSpecify an IPv6 address by using CIDR notation. For example:
\n\tTo configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128
.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies the IP address type (IPV4
or IPV6
) and the IP address range (in CIDR format) that web requests originate from.
The IPSetId
for an IPSet. You can use IPSetId
in a GetIPSet request to get detailed \n\t\t\tinformation about an IPSet.
A friendly name or description of the IPSet. You can't change the name of an IPSet
after you create it.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nContains the identifier and the name of the IPSet
.
Specifies whether to insert or delete an IP address with UpdateIPSet.
", "smithy.api#required": {} } }, "IPSetDescriptor": { "target": "com.amazonaws.wafregional#IPSetDescriptor", "traits": { "smithy.api#documentation": "The IP address type (IPV4
or IPV6
) and the IP address range (in CIDR notation) that web requests originate from.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies the type of update to perform to an IPSet with UpdateIPSet.
" } }, "com.amazonaws.wafregional#IPSetUpdates": { "type": "list", "member": { "target": "com.amazonaws.wafregional#IPSetUpdate" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.wafregional#IPString": { "type": "string" }, "com.amazonaws.wafregional#IgnoreUnsupportedType": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.wafregional#ListActivatedRulesInRuleGroup": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListActivatedRulesInRuleGroupRequest" }, "output": { "target": "com.amazonaws.wafregional#ListActivatedRulesInRuleGroupResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidParameterException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of ActivatedRule objects.
" } }, "com.amazonaws.wafregional#ListActivatedRulesInRuleGroupRequest": { "type": "structure", "members": { "RuleGroupId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The RuleGroupId
of the RuleGroup for which you want to get a list of ActivatedRule objects.
If you specify a value for Limit
and you have more ActivatedRules
than the value of Limit
, \n AWS WAF returns a NextMarker
value in the response that allows you to list another group of ActivatedRules
. \n For the second and subsequent ListActivatedRulesInRuleGroup
requests, specify the value of NextMarker
\n from the previous response to get information about another batch of ActivatedRules
.
Specifies the number of ActivatedRules
that you want AWS WAF to return for this request. If you have more ActivatedRules
than the number that you specify for Limit
, the response includes a \n NextMarker
value that you can use to get another batch of ActivatedRules
.
If you have more ActivatedRules
than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more ActivatedRules
, submit another ListActivatedRulesInRuleGroup
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of ActivatedRules
objects.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of ByteMatchSetSummary objects.
" } }, "com.amazonaws.wafregional#ListByteMatchSetsRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more ByteMatchSets
than the value of Limit
, \n\t\t\tAWS WAF returns a NextMarker
value in the response that allows you to list another group of ByteMatchSets
. \n\t\t\tFor the second and subsequent ListByteMatchSets
requests, specify the value of NextMarker
\n\t\t\tfrom the previous response to get information about another batch of ByteMatchSets
.
Specifies the number of ByteMatchSet
objects that you want AWS WAF to return for this request. If you have more \n\t\t\tByteMatchSets
objects than the number you specify for Limit
, the response includes a \n\t\t\tNextMarker
value that you can use to get another batch of ByteMatchSet
objects.
If you have more ByteMatchSet
objects than the number that you specified for Limit
in the request, \n\t\t\tthe response includes a NextMarker
value. To list more ByteMatchSet
objects, submit another \n\t\t\tListByteMatchSets
request, and specify the NextMarker
value from the response in the \n\t\t\tNextMarker
value in the next request.
An array of ByteMatchSetSummary objects.
" } } } }, "com.amazonaws.wafregional#ListGeoMatchSets": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListGeoMatchSetsRequest" }, "output": { "target": "com.amazonaws.wafregional#ListGeoMatchSetsResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of GeoMatchSetSummary objects in the response.
" } }, "com.amazonaws.wafregional#ListGeoMatchSetsRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more GeoMatchSet
s than the value of Limit
, \n\t\t\tAWS WAF returns a NextMarker
value in the response that allows you to list another group of GeoMatchSet
objects. \n\t\t\tFor the second and subsequent ListGeoMatchSets
requests, specify the value of NextMarker
\n\t\t\tfrom the previous response to get information about another batch of GeoMatchSet
objects.
Specifies the number of GeoMatchSet
objects that you want AWS WAF to return for this request. If you have more \n\t\t\tGeoMatchSet
objects than the number you specify for Limit
, the response includes a \n\t\t\tNextMarker
value that you can use to get another batch of GeoMatchSet
objects.
If you have more GeoMatchSet
objects than the number that you specified for Limit
in the request, \n\t\t\tthe response includes a NextMarker
value. To list more GeoMatchSet
objects, submit another \n\t\t\tListGeoMatchSets
request, and specify the NextMarker
value from the response in the \n\t\t\tNextMarker
value in the next request.
An array of GeoMatchSetSummary objects.
" } } } }, "com.amazonaws.wafregional#ListIPSets": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListIPSetsRequest" }, "output": { "target": "com.amazonaws.wafregional#ListIPSetsResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of IPSetSummary objects in the response.
" } }, "com.amazonaws.wafregional#ListIPSetsRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "AWS WAF returns a NextMarker
value in the response that allows you to\n list another group of IPSets
. For the second and subsequent\n ListIPSets
requests, specify the value of NextMarker
from the\n previous response to get information about another batch of IPSets
.
Specifies the number of IPSet
objects that you want AWS WAF to return for this request. If you have more \n\t\t\tIPSet
objects than the number you specify for Limit
, the response includes a \n\t\t\tNextMarker
value that you can use to get another batch of IPSet
objects.
To list more IPSet
objects, submit another ListIPSets
\n request, and in the next request use the NextMarker
response value as the\n NextMarker
value.
An array of IPSetSummary objects.
" } } } }, "com.amazonaws.wafregional#ListLoggingConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListLoggingConfigurationsRequest" }, "output": { "target": "com.amazonaws.wafregional#ListLoggingConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidParameterException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of LoggingConfiguration objects.
" } }, "com.amazonaws.wafregional#ListLoggingConfigurationsRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more LoggingConfigurations
than the value of Limit
, \n\t\t\tAWS WAF returns a NextMarker
value in the response that allows you to list another group of LoggingConfigurations
. \n\t\t\tFor the second and subsequent ListLoggingConfigurations
requests, specify the value of NextMarker
\n\t\t\tfrom the previous response to get information about another batch of ListLoggingConfigurations
.
Specifies the number of LoggingConfigurations
that you want AWS WAF to return for this request. If you have more LoggingConfigurations
than the number that you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of LoggingConfigurations
.
An array of LoggingConfiguration objects.
" } }, "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you have more LoggingConfigurations
than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more LoggingConfigurations
, submit another ListLoggingConfigurations
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of RuleSummary objects.
" } }, "com.amazonaws.wafregional#ListRateBasedRulesRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more Rules
\n than the value of Limit
, AWS WAF returns a NextMarker
value in the\n response that allows you to list another group of Rules
. For the second and\n subsequent ListRateBasedRules
requests, specify the value of\n NextMarker
from the previous response to get information about another\n batch of Rules
.
Specifies the number of Rules
that you want AWS WAF to return for this\n request. If you have more Rules
than the number that you specify for\n Limit
, the response includes a NextMarker
value that you can\n use to get another batch of Rules
.
If you have more Rules
than the number that you specified for\n Limit
in the request, the response includes a NextMarker
\n value. To list more Rules
, submit another ListRateBasedRules
\n request, and specify the NextMarker
value from the response in the\n NextMarker
value in the next request.
An array of RuleSummary objects.
" } } } }, "com.amazonaws.wafregional#ListRegexMatchSets": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListRegexMatchSetsRequest" }, "output": { "target": "com.amazonaws.wafregional#ListRegexMatchSetsResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of RegexMatchSetSummary objects.
" } }, "com.amazonaws.wafregional#ListRegexMatchSetsRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more RegexMatchSet
objects than the value of Limit
, \n\t\t\tAWS WAF returns a NextMarker
value in the response that allows you to list another group of ByteMatchSets
. \n\t\t\tFor the second and subsequent ListRegexMatchSets
requests, specify the value of NextMarker
\n\t\t\tfrom the previous response to get information about another batch of RegexMatchSet
objects.
Specifies the number of RegexMatchSet
objects that you want AWS WAF to return for this request. If you have more \n\t\t\tRegexMatchSet
objects than the number you specify for Limit
, the response includes a \n\t\t\tNextMarker
value that you can use to get another batch of RegexMatchSet
objects.
If you have more RegexMatchSet
objects than the number that you specified for Limit
in the request, \n\t\t\tthe response includes a NextMarker
value. To list more RegexMatchSet
objects, submit another \n\t\t\tListRegexMatchSets
request, and specify the NextMarker
value from the response in the \n\t\t\tNextMarker
value in the next request.
An array of RegexMatchSetSummary objects.
" } } } }, "com.amazonaws.wafregional#ListRegexPatternSets": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListRegexPatternSetsRequest" }, "output": { "target": "com.amazonaws.wafregional#ListRegexPatternSetsResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of RegexPatternSetSummary objects.
" } }, "com.amazonaws.wafregional#ListRegexPatternSetsRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more RegexPatternSet
objects than the value of Limit
, \n\t\t\tAWS WAF returns a NextMarker
value in the response that allows you to list another group of RegexPatternSet
objects. \n\t\t\tFor the second and subsequent ListRegexPatternSets
requests, specify the value of NextMarker
\n\t\t\tfrom the previous response to get information about another batch of RegexPatternSet
objects.
Specifies the number of RegexPatternSet
objects that you want AWS WAF to return for this request. If you have more \n\t\t\tRegexPatternSet
objects than the number you specify for Limit
, the response includes a \n\t\t\tNextMarker
value that you can use to get another batch of RegexPatternSet
objects.
If you have more RegexPatternSet
objects than the number that you specified for Limit
in the request, \n\t\t\tthe response includes a NextMarker
value. To list more RegexPatternSet
objects, submit another \n\t\t\tListRegexPatternSets
request, and specify the NextMarker
value from the response in the \n\t\t\tNextMarker
value in the next request.
An array of RegexPatternSetSummary objects.
" } } } }, "com.amazonaws.wafregional#ListResourcesForWebACL": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListResourcesForWebACLRequest" }, "output": { "target": "com.amazonaws.wafregional#ListResourcesForWebACLResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" }, { "target": "com.amazonaws.wafregional#WAFInvalidParameterException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic Regional documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of resources associated with the specified web ACL.
" } }, "com.amazonaws.wafregional#ListResourcesForWebACLRequest": { "type": "structure", "members": { "WebACLId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The unique identifier (ID) of the web ACL for which to list the associated resources.
", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.wafregional#ResourceType", "traits": { "smithy.api#documentation": "The type of resource to list, either an application load balancer or Amazon API Gateway.
" } } } }, "com.amazonaws.wafregional#ListResourcesForWebACLResponse": { "type": "structure", "members": { "ResourceArns": { "target": "com.amazonaws.wafregional#ResourceArns", "traits": { "smithy.api#documentation": "An array of ARNs (Amazon Resource Names) of the resources associated with the specified web ACL. An array with zero elements is returned if there are no resources associated with the web ACL.
" } } } }, "com.amazonaws.wafregional#ListRuleGroups": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListRuleGroupsRequest" }, "output": { "target": "com.amazonaws.wafregional#ListRuleGroupsResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of RuleGroup objects.
" } }, "com.amazonaws.wafregional#ListRuleGroupsRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more RuleGroups
than the value of Limit
, \n AWS WAF returns a NextMarker
value in the response that allows you to list another group of RuleGroups
. \n For the second and subsequent ListRuleGroups
requests, specify the value of NextMarker
\n from the previous response to get information about another batch of RuleGroups
.
Specifies the number of RuleGroups
that you want AWS WAF to return for this request. If you have more RuleGroups
than the number that you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of RuleGroups
.
If you have more RuleGroups
than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more RuleGroups
, submit another ListRuleGroups
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of RuleGroup objects.
" } } } }, "com.amazonaws.wafregional#ListRules": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListRulesRequest" }, "output": { "target": "com.amazonaws.wafregional#ListRulesResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of RuleSummary objects.
" } }, "com.amazonaws.wafregional#ListRulesRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more Rules
than the value of Limit
, \n\t\t\tAWS WAF returns a NextMarker
value in the response that allows you to list another group of Rules
. \n\t\t\tFor the second and subsequent ListRules
requests, specify the value of NextMarker
\n\t\t\tfrom the previous response to get information about another batch of Rules
.
Specifies the number of Rules
that you want AWS WAF to return for this request. If you have more \t\t\tRules
than the number that you specify for Limit
, the response includes a \n\t\t\tNextMarker
value that you can use to get another batch of Rules
.
If you have more Rules
than the number that you specified for Limit
in the request, \t\t\tthe response includes a NextMarker
value. To list more Rules
, submit another \n\t\t\tListRules
request, and specify the NextMarker
value from the response in the \n\t\t\tNextMarker
value in the next request.
An array of RuleSummary objects.
" } } } }, "com.amazonaws.wafregional#ListSizeConstraintSets": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListSizeConstraintSetsRequest" }, "output": { "target": "com.amazonaws.wafregional#ListSizeConstraintSetsResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of SizeConstraintSetSummary objects.
" } }, "com.amazonaws.wafregional#ListSizeConstraintSetsRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more SizeConstraintSets
than the value of Limit
, \n\t\t\tAWS WAF returns a NextMarker
value in the response that allows you to list another group of SizeConstraintSets
. \n\t\t\tFor the second and subsequent ListSizeConstraintSets
requests, specify the value of NextMarker
\t\t\tfrom the previous response to get information about another batch of SizeConstraintSets
.
Specifies the number of SizeConstraintSet
objects that you want AWS WAF to return for this request. If you have more \n\t\t\tSizeConstraintSets
objects than the number you specify for Limit
, the response includes a \n\t\t\tNextMarker
value that you can use to get another batch of SizeConstraintSet
objects.
If you have more SizeConstraintSet
objects than the number that you specified for Limit
in the request, \n\t\t\tthe response includes a NextMarker
value. To list more SizeConstraintSet
objects, submit another \n\t\t\tListSizeConstraintSets
request, and specify the NextMarker
value from the response in the \n\t\t\tNextMarker
value in the next request.
An array of SizeConstraintSetSummary objects.
" } } } }, "com.amazonaws.wafregional#ListSqlInjectionMatchSets": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListSqlInjectionMatchSetsRequest" }, "output": { "target": "com.amazonaws.wafregional#ListSqlInjectionMatchSetsResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of SqlInjectionMatchSet objects.
" } }, "com.amazonaws.wafregional#ListSqlInjectionMatchSetsRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more SqlInjectionMatchSet objects than the value of \n\t\t\tLimit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of \n\t\t\tSqlInjectionMatchSets
. For the second and subsequent ListSqlInjectionMatchSets
requests, specify the \n\t\t\tvalue of NextMarker
from the previous response to get information about another batch of SqlInjectionMatchSets
.
Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more \n\t\t\tSqlInjectionMatchSet
objects than the number you specify for Limit
, the response includes a \n\t\t\tNextMarker
value that you can use to get another batch of Rules
.
A request to list the SqlInjectionMatchSet objects created by the current AWS account.
" } }, "com.amazonaws.wafregional#ListSqlInjectionMatchSetsResponse": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you have more SqlInjectionMatchSet objects than the number that you specified for Limit
in the request, \n\t\t\tthe response includes a NextMarker
value. To list more SqlInjectionMatchSet
objects, submit another \n\t\t\tListSqlInjectionMatchSets
request, and specify the NextMarker
value from the response in the \n\t\t\tNextMarker
value in the next request.
An array of SqlInjectionMatchSetSummary objects.
" } } }, "traits": { "smithy.api#documentation": "The response to a ListSqlInjectionMatchSets request.
" } }, "com.amazonaws.wafregional#ListSubscribedRuleGroups": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListSubscribedRuleGroupsRequest" }, "output": { "target": "com.amazonaws.wafregional#ListSubscribedRuleGroupsResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of RuleGroup objects that you are subscribed to.
" } }, "com.amazonaws.wafregional#ListSubscribedRuleGroupsRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more ByteMatchSets
subscribed rule groups than the value of Limit
, \n\t\t\tAWS WAF returns a NextMarker
value in the response that allows you to list another group of subscribed rule groups. \n\t\t\tFor the second and subsequent ListSubscribedRuleGroupsRequest
requests, specify the value of NextMarker
\n\t\t\tfrom the previous response to get information about another batch of subscribed rule groups.
Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more \n\t\t\tobjects than the number you specify for Limit
, the response includes a \n\t\t\tNextMarker
value that you can use to get another batch of objects.
If you have more objects than the number that you specified for Limit
in the request, \n\t\t\tthe response includes a NextMarker
value. To list more objects, submit another \n\t\t\tListSubscribedRuleGroups
request, and specify the NextMarker
value from the response in the \n\t\t\tNextMarker
value in the next request.
An array of RuleGroup objects.
" } } } }, "com.amazonaws.wafregional#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.wafregional#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFBadRequestException" }, { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidParameterException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" }, { "target": "com.amazonaws.wafregional#WAFTagOperationException" }, { "target": "com.amazonaws.wafregional#WAFTagOperationInternalErrorException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nRetrieves the tags associated with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
\nTagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
" } }, "com.amazonaws.wafregional#ListTagsForResourceRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "" } }, "Limit": { "target": "com.amazonaws.wafregional#PaginationLimit", "traits": { "smithy.api#documentation": "" } }, "ResourceARN": { "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#ListTagsForResourceResponse": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "" } }, "TagInfoForResource": { "target": "com.amazonaws.wafregional#TagInfoForResource", "traits": { "smithy.api#documentation": "" } } } }, "com.amazonaws.wafregional#ListWebACLs": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListWebACLsRequest" }, "output": { "target": "com.amazonaws.wafregional#ListWebACLsResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of WebACLSummary objects in the response.
" } }, "com.amazonaws.wafregional#ListWebACLsRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more WebACL
objects than the number that you specify \n\t\t\tfor Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of \n\t\t\tWebACL
objects. For the second and subsequent ListWebACLs
requests, specify the value of NextMarker
\n\t\t\tfrom the previous response to get information about another batch of WebACL
objects.
Specifies the number of WebACL
objects that you want AWS WAF to return for this request. If you have more \n\t\t\tWebACL
objects than the number that you specify for Limit
, the response includes a \n\t\t\tNextMarker
value that you can use to get another batch of WebACL
objects.
If you have more WebACL
objects than the number that you specified for Limit
in the request, \n\t\t\tthe response includes a NextMarker
value. To list more WebACL
objects, submit another \n\t\t\tListWebACLs
request, and specify the NextMarker
value from the response in the \n\t\t\tNextMarker
value in the next request.
An array of WebACLSummary objects.
" } } } }, "com.amazonaws.wafregional#ListXssMatchSets": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#ListXssMatchSetsRequest" }, "output": { "target": "com.amazonaws.wafregional#ListXssMatchSetsResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturns an array of XssMatchSet objects.
" } }, "com.amazonaws.wafregional#ListXssMatchSetsRequest": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you specify a value for Limit
and you have more XssMatchSet objects than the value of \n\t\t\tLimit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of \n\t\t\tXssMatchSets
. For the second and subsequent ListXssMatchSets
requests, specify the \n\t\t\tvalue of NextMarker
from the previous response to get information about another batch of XssMatchSets
.
Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more \n\t\t\tXssMatchSet
objects than the number you specify for Limit
, the response includes a \n\t\t\tNextMarker
value that you can use to get another batch of Rules
.
A request to list the XssMatchSet objects created by the current AWS account.
" } }, "com.amazonaws.wafregional#ListXssMatchSetsResponse": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "If you have more XssMatchSet objects than the number that you specified for Limit
in the request, \n\t\t\tthe response includes a NextMarker
value. To list more XssMatchSet
objects, submit another \n\t\t\tListXssMatchSets
request, and specify the NextMarker
value from the response in the \n\t\t\tNextMarker
value in the next request.
An array of XssMatchSetSummary objects.
" } } }, "traits": { "smithy.api#documentation": "The response to a ListXssMatchSets request.
" } }, "com.amazonaws.wafregional#LogDestinationConfigs": { "type": "list", "member": { "target": "com.amazonaws.wafregional#ResourceArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.wafregional#LoggingConfiguration": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the web ACL that you want to associate with\n LogDestinationConfigs
.
An array of Amazon Kinesis Data Firehose ARNs.
", "smithy.api#required": {} } }, "RedactedFields": { "target": "com.amazonaws.wafregional#RedactedFields", "traits": { "smithy.api#documentation": "The parts of the request that you want redacted from the logs. For\n example,\n if you redact the cookie field, the cookie field in the firehose will be\n xxx
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe Amazon Kinesis Data Firehose, RedactedFields
\n information, and the web ACL Amazon Resource Name (ARN).
Set Negated
to False
if you want AWS WAF to allow, block, or count requests based on the settings in the \n\t\t specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n\t\t\tFor 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 \n\t\t of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n\t\t\tFor example, if an IPSet
includes the IP address 192.0.2.44
, AWS WAF will allow, block, or count requests based on \n\t\t\tall IP addresses except \n 192.0.2.44
.
The type of predicate in a Rule
, such as ByteMatch
or IPSet
.
A unique identifier for a predicate in a Rule
, such as ByteMatchSetId
or IPSetId
. \n\t\t\tThe ID is returned by the corresponding Create
or List
command.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects \n\t\t\tthat you want to add to a Rule
and, for each object, indicates whether you want to negate the settings, for example, requests that do \n\t\t\tNOT originate from the IP address 192.0.2.44.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nAssociates a LoggingConfiguration with a specified web ACL.
\n\tYou can access information about all traffic that AWS WAF inspects using the following\n steps:
\n\tCreate an Amazon Kinesis Data\n Firehose.
\n\tCreate the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).
\n\tDo not create the data firehose using a Kinesis stream
as your source.
Associate that firehose to your web ACL using a PutLoggingConfiguration
request.
When you successfully enable logging using a PutLoggingConfiguration
request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
The Amazon Kinesis Data Firehose that contains the inspected traffic\n information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL\n to monitor.
\nWhen specifying Type
in RedactedFields
, you must use one of\n the following values: URI
, QUERY_STRING
, HEADER
,\n or METHOD
.
The LoggingConfiguration that you submitted in the request.
" } } } }, "com.amazonaws.wafregional#PutPermissionPolicy": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#PutPermissionPolicyRequest" }, "output": { "target": "com.amazonaws.wafregional#PutPermissionPolicyResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidPermissionPolicyException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" }, { "target": "com.amazonaws.wafregional#WAFStaleDataException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nAttaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.
\nThe PutPermissionPolicy
is subject to the following restrictions:
You can attach only one policy with each PutPermissionPolicy
request.
The policy must include an Effect
, Action
and Principal
.
\n Effect
must specify Allow
.
The Action
in the policy must be waf:UpdateWebACL
, waf-regional:UpdateWebACL
, waf:GetRuleGroup
and waf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected.
The policy cannot include a Resource
parameter.
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
\nThe user making the request must be the owner of the RuleGroup.
\nYour policy must be composed using IAM Policy version 2012-10-17.
\nFor more information, see IAM Policies.
\n \nAn example of a valid policy parameter is shown in the Examples section below.
" } }, "com.amazonaws.wafregional#PutPermissionPolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
", "smithy.api#required": {} } }, "Policy": { "target": "com.amazonaws.wafregional#PolicyString", "traits": { "smithy.api#documentation": "The policy to attach to the specified RuleGroup.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#PutPermissionPolicyResponse": { "type": "structure", "members": {} }, "com.amazonaws.wafregional#RateBasedRule": { "type": "structure", "members": { "RuleId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "A unique identifier for a RateBasedRule
. You use RuleId
to\n get more information about a RateBasedRule
(see GetRateBasedRule), update a RateBasedRule
(see UpdateRateBasedRule), insert a RateBasedRule
into a\n WebACL
or delete one from a WebACL
(see UpdateWebACL), or delete a RateBasedRule
from AWS WAF (see DeleteRateBasedRule).
A friendly name or description for a RateBasedRule
. You can't change the\n name of a RateBasedRule
after you create it.
A friendly name or description for the metrics for a RateBasedRule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the\n RateBasedRule
.
The Predicates
object contains one Predicate
element for\n each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a\n RateBasedRule
.
The field that AWS WAF uses to determine if requests are likely arriving from single\n source and thus subject to rate monitoring. The only valid value for RateKey
\n is IP
. IP
indicates that requests arriving from the same IP\n address are subject to the RateLimit
that is specified in the\n RateBasedRule
.
The maximum number of requests, which have an identical value in the field specified\n by the RateKey
, allowed in a five-minute period. If the number of requests\n exceeds the RateLimit
and the other predicates specified in the rule are also\n met, AWS WAF triggers the action that is specified for this rule.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nA RateBasedRule
is identical to a regular Rule, with\n one addition: a RateBasedRule
counts the number of requests that arrive from a\n specified IP address every five minutes. For example, based on recent requests that you've\n seen from an attacker, you might create a RateBasedRule
that includes the\n following conditions:
The requests come from 192.0.2.44.
\nThey contain the value BadBot
in the User-Agent
\n header.
In the rule, you also define the rate limit as 1,000.
\nRequests that meet both of these conditions and exceed 1,000 requests every five\n minutes trigger the rule's action (block or count), which is defined in the web\n ACL.
" } }, "com.amazonaws.wafregional#RateKey": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IP", "name": "IP" } ] } }, "com.amazonaws.wafregional#RateLimit": { "type": "long", "traits": { "smithy.api#range": { "min": 100, "max": 2000000000 } } }, "com.amazonaws.wafregional#RedactedFields": { "type": "list", "member": { "target": "com.amazonaws.wafregional#FieldToMatch" } }, "com.amazonaws.wafregional#RegexMatchSet": { "type": "structure", "members": { "RegexMatchSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The RegexMatchSetId
for a RegexMatchSet
. You use RegexMatchSetId
to get information about a \n\t\t\tRegexMatchSet
(see GetRegexMatchSet), update a RegexMatchSet
(see UpdateRegexMatchSet), \n\t\t\tinsert a RegexMatchSet
into a Rule
or delete one from a Rule
(see UpdateRule), and \n\t\t\tdelete a RegexMatchSet
from AWS WAF (see DeleteRegexMatchSet).
\n RegexMatchSetId
is returned by CreateRegexMatchSet and by ListRegexMatchSets.
A friendly name or description of the RegexMatchSet. You can't change Name
after you create a \n\t\t\tRegexMatchSet
.
Contains an array of RegexMatchTuple objects. Each RegexMatchTuple
\n\t\t\t\tobject contains:
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent
header.
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
\nWhether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
\n\t\t\tThis is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nIn a GetRegexMatchSet request, RegexMatchSet
is a complex type that contains the RegexMatchSetId
and \n\t\t\tName
of a RegexMatchSet
, and the values that you specified when you updated the RegexMatchSet
.
The values are contained in a RegexMatchTuple
object, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a RegexMatchSet
contains more than one \n\t\t\tRegexMatchTuple
object, a request needs to match the settings in only one ByteMatchTuple
\n\t\t\tto be considered a match.
The RegexMatchSetId
for a RegexMatchSet
. You use RegexMatchSetId
to get information about a RegexMatchSet
,\n\t\t\tupdate a RegexMatchSet
, remove a RegexMatchSet
from a Rule
, and delete a RegexMatchSet
from AWS WAF.
\n RegexMatchSetId
is returned by CreateRegexMatchSet and by ListRegexMatchSets.
A friendly name or description of the RegexMatchSet. You can't change Name
after you create a RegexMatchSet
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturned by ListRegexMatchSets. Each RegexMatchSetSummary
object includes the Name
and \n\t\t\tRegexMatchSetId
for one RegexMatchSet.
Specifies whether to insert or delete a RegexMatchTuple.
", "smithy.api#required": {} } }, "RegexMatchTuple": { "target": "com.amazonaws.wafregional#RegexMatchTuple", "traits": { "smithy.api#documentation": "Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for.\n If you specify DELETE
for the value of Action
, the RegexMatchTuple
values must \n exactly match the values in the RegexMatchTuple
that you want to delete from the RegexMatchSet
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nIn an UpdateRegexMatchSet request, RegexMatchSetUpdate
specifies whether to insert or delete a \n RegexMatchTuple and includes the settings for the RegexMatchTuple
.
Specifies where in a web request to look for the RegexPatternSet
.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on RegexPatternSet
before inspecting a request for a match.
You can only specify a single type of TextTransformation.
\t\t\t\n\t\t\n CMD_LINE\n
\n\t\tWhen 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:
\n\t\tDelete the following characters: \\ \" ' ^
\nDelete spaces before the following characters: / (
\nReplace the following characters with a space: , ;
\nReplace multiple spaces with one space
\nConvert uppercase letters (A-Z) to lowercase (a-z)
\n\n COMPRESS_WHITE_SPACE\n
\n\t\tUse this option to replace the following characters with a space character (decimal 32):
\n\t\t\\f, formfeed, decimal 12
\n\\t, tab, decimal 9
\n\\n, newline, decimal 10
\n\\r, carriage return, decimal 13
\n\\v, vertical tab, decimal 11
\nnon-breaking space, decimal 160
\n\n COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
\n HTML_ENTITY_DECODE\n
\n\t\tUse this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs \n\t\t\tthe following operations:
Replaces (ampersand)quot;
with \"
\n
Replaces (ampersand)nbsp;
with a non-breaking space, decimal 160
Replaces (ampersand)lt;
with a \"less than\" symbol
Replaces (ampersand)gt;
with >
\n
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;
, with the corresponding \n\t\t\t\tcharacters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;
, with the corresponding \n\t\t\t\tcharacters
\n LOWERCASE\n
\n\t\tUse this option to convert uppercase letters (A-Z) to lowercase (a-z).
\t\t\n\t\t\n URL_DECODE\n
\n\t\tUse this option to decode a URL-encoded value.
\t\t\n\t\t\n NONE\n
\n\t\tSpecify NONE
if you don't want to perform any text transformations.
The RegexPatternSetId
for a RegexPatternSet
. You use RegexPatternSetId
to get information about a \n\t\t\tRegexPatternSet
(see GetRegexPatternSet), update a RegexPatternSet
(see UpdateRegexPatternSet), \n\t\t\tinsert a RegexPatternSet
into a RegexMatchSet
or delete one from a RegexMatchSet
(see UpdateRegexMatchSet), and \n\t\t\tdelete an RegexPatternSet
from AWS WAF (see DeleteRegexPatternSet).
\n\t\t RegexPatternSetId
is returned by CreateRegexPatternSet and by ListRegexPatternSets.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each RegexMatchTuple
object contains:
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent
header.
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
\nWhether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
\n\t\t\tThe identifier for the RegexPatternSet
. You use RegexPatternSetId
to get information about a RegexPatternSet
,\n update a RegexPatternSet
, remove a RegexPatternSet
from a RegexMatchSet
, and delete a RegexPatternSet
from AWS WAF.
\n RegexMatchSetId
is returned by CreateRegexPatternSet and by ListRegexPatternSets.
A friendly name or description of the RegexPatternSet. You can't change Name
after you create a RegexPatternSet
.
Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe RegexPatternSet
specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.
The RegexPatternSetId
for a RegexPatternSet
. You use RegexPatternSetId
to get information about a RegexPatternSet
,\n update a RegexPatternSet
, remove a RegexPatternSet
from a RegexMatchSet
, and delete a RegexPatternSet
from AWS WAF.
\n RegexPatternSetId
is returned by CreateRegexPatternSet and by ListRegexPatternSets.
A friendly name or description of the RegexPatternSet. You can't change Name
after you create a RegexPatternSet
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nReturned by ListRegexPatternSets. Each RegexPatternSetSummary
object includes the Name
and \n RegexPatternSetId
for one RegexPatternSet.
Specifies whether to insert or delete a RegexPatternString
.
Specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nIn an UpdateRegexPatternSet request, RegexPatternSetUpdate
specifies whether to insert or delete a \n RegexPatternString
and includes the settings for the RegexPatternString
.
A unique identifier for a Rule
. You use RuleId
to get more information about a Rule
(see GetRule), \n\t\t\tupdate a Rule
(see UpdateRule), insert a Rule
into a WebACL
or delete a \n\t\t\tone from a WebACL
(see UpdateWebACL), or delete a Rule
from AWS WAF (see DeleteRule).
\n RuleId
is returned by CreateRule and by ListRules.
The friendly name or description for the Rule
. You can't change the name of a Rule
after you create it.
A friendly name or description for the metrics for this Rule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName
after you create the Rule
.
The Predicates
object contains one Predicate
element for each ByteMatchSet, IPSet, or \n\t\t\tSqlInjectionMatchSet object that you want to include in a Rule
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nA combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you \n\t\t\twant 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
\n
A ByteMatchSet
that causes AWS WAF to search for web requests for which the value of the User-Agent
\n\t\t\t\theader is BadBot
.
To match the settings in this Rule
, a request must originate from 192.0.2.44
AND include a User-Agent
\n\t\t\theader for which the value is BadBot
.
A unique identifier for a RuleGroup
. You use RuleGroupId
to get more information about a RuleGroup
(see GetRuleGroup), \n update a RuleGroup
(see UpdateRuleGroup), insert a RuleGroup
into a WebACL
or delete a \n one from a WebACL
(see UpdateWebACL), or delete a RuleGroup
from AWS WAF (see DeleteRuleGroup).
\n RuleGroupId
is returned by CreateRuleGroup and by ListRuleGroups.
The friendly name or description for the RuleGroup
. You can't change the name of a RuleGroup
after you create it.
A friendly name or description for the metrics for this RuleGroup
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nA collection of predefined rules that you can add to a web ACL.
\n\tRule groups are subject to the following limits:
\n\tThree rule groups per account. You can request an increase to this limit by contacting customer support.
\nOne rule group per web ACL.
\nTen rules per rule group.
\nA unique identifier for a RuleGroup
. You use RuleGroupId
to get more information about a RuleGroup
(see GetRuleGroup), \n update a RuleGroup
(see UpdateRuleGroup), insert a RuleGroup
into a WebACL
or delete \n one from a WebACL
(see UpdateWebACL), or delete a RuleGroup
from AWS WAF (see DeleteRuleGroup).
\n RuleGroupId
is returned by CreateRuleGroup and by ListRuleGroups.
A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup
after you create it.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nContains the identifier and the friendly name or description of the RuleGroup
.
Specify INSERT
to add an ActivatedRule
to a RuleGroup
. Use DELETE
to remove an \n ActivatedRule
from a RuleGroup
.
The ActivatedRule
object specifies a Rule
that you want to insert or delete, \n 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
\n (ALLOW
, BLOCK
, or COUNT
).
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies an ActivatedRule
and indicates whether you want to add it to a \n RuleGroup
or delete it from a RuleGroup
.
A unique identifier for a Rule
. You use RuleId
to get more information about a Rule
(see GetRule), \n\t\t\tupdate a Rule
(see UpdateRule), insert a Rule
into a WebACL
or delete \n\t\t\tone from a WebACL
(see UpdateWebACL), or delete a Rule
from AWS WAF (see DeleteRule).
\n RuleId
is returned by CreateRule and by ListRules.
A friendly name or description of the Rule. You can't change the name of a Rule
after you create it.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nContains the identifier and the friendly name or description of the Rule
.
Specify INSERT
to add a Predicate
to a Rule
. Use DELETE
to remove a \n\t\t\tPredicate
from a Rule
.
The ID of the Predicate
(such as an IPSet
) that you want to add to a Rule
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies a Predicate
(such as an IPSet
) and indicates whether you want to add it to a \n\t\t\tRule
or delete it from a Rule
.
A complex type that contains detailed information about the request.
", "smithy.api#required": {} } }, "Weight": { "target": "com.amazonaws.wafregional#SampleWeight", "traits": { "smithy.api#documentation": "A value that indicates how one result in the response relates proportionally to other results in the response. \n\t\t\tA result that has a weight of 2
represents roughly twice as many CloudFront web requests as a result \n\t\t\tthat has a weight of 1
.
The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).
" } }, "Action": { "target": "com.amazonaws.wafregional#Action", "traits": { "smithy.api#documentation": "The action for the Rule
that the request matched: ALLOW
, BLOCK
, or COUNT
.
This value is returned if the GetSampledRequests
request specifies the ID of a RuleGroup
rather than the ID of an individual rule. RuleWithinRuleGroup
is the rule within the specified RuleGroup
that matched the request listed in the response.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe response from a GetSampledRequests request includes a SampledHTTPRequests
complex type that \n\t\t\tappears as SampledRequests
in the response syntax. SampledHTTPRequests
contains one \n\t\t\tSampledHTTPRequest
object for each web request that is returned by GetSampledRequests
.
Specifies where in a web request to look for the size constraint.
", "smithy.api#required": {} } }, "TextTransformation": { "target": "com.amazonaws.wafregional#TextTransformation", "traits": { "smithy.api#documentation": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on FieldToMatch
before inspecting it for a match.
You can only specify a single type of TextTransformation.
\t\t\t\n\t\tNote that if you choose BODY
for the value of Type
, you must choose NONE
for TextTransformation
\n\t\t\tbecause CloudFront forwards only the first 8192 bytes for inspection.
\n NONE\n
\n\t\tSpecify NONE
if you don't want to perform any text transformations.
\n CMD_LINE\n
\n\t\tWhen 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:
\n\t\tDelete the following characters: \\ \" ' ^
\nDelete spaces before the following characters: / (
\nReplace the following characters with a space: , ;
\nReplace multiple spaces with one space
\nConvert uppercase letters (A-Z) to lowercase (a-z)
\n\n COMPRESS_WHITE_SPACE\n
\n\t\tUse this option to replace the following characters with a space character (decimal 32):
\n\t\t\\f, formfeed, decimal 12
\n\\t, tab, decimal 9
\n\\n, newline, decimal 10
\n\\r, carriage return, decimal 13
\n\\v, vertical tab, decimal 11
\nnon-breaking space, decimal 160
\n\n COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
\n HTML_ENTITY_DECODE\n
\n\t\tUse this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs \n\t\t\tthe following operations:
Replaces (ampersand)quot;
with \"
\n
Replaces (ampersand)nbsp;
with a non-breaking space, decimal 160
Replaces (ampersand)lt;
with a \"less than\" symbol
Replaces (ampersand)gt;
with >
\n
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;
, with the corresponding \n\t\t\t\tcharacters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;
, with the corresponding \n\t\t\t\tcharacters
\n LOWERCASE\n
\n\t\tUse this option to convert uppercase letters (A-Z) to lowercase (a-z).
\t\t\n\t\t\n URL_DECODE\n
\n\t\tUse this option to decode a URL-encoded value.
", "smithy.api#required": {} } }, "ComparisonOperator": { "target": "com.amazonaws.wafregional#ComparisonOperator", "traits": { "smithy.api#documentation": "The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size
and FieldToMatch
\n\t\t\tto build an expression in the form of \"Size
\n ComparisonOperator
size in bytes of FieldToMatch
\". If that expression\n\t\t\tis true, the SizeConstraint
is considered to match.
\n EQ: Used to test if the Size
is equal to the size of the FieldToMatch
\n
\n NE: Used to test if the Size
is not equal to the size of the FieldToMatch
\n
\n LE: Used to test if the Size
is less than or equal to the size of the FieldToMatch
\n
\n LT: Used to test if the Size
is strictly less than the size of the FieldToMatch
\n
\n GE: Used to test if the Size
is greater than or equal to the size of the FieldToMatch
\n
\n GT: Used to test if the Size
is strictly greater than the size of the FieldToMatch
\n
The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch
. AWS WAF uses this in combination \n\t\t\twith ComparisonOperator
and FieldToMatch
to build an expression in the form of \"Size
\n ComparisonOperator
size \n\t\t\tin 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).
\n\t\tIf you specify URI
for the value of Type
, the / in the URI counts as one character. \n\t\t\tFor example, the URI /logo.jpg
is nine characters long.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies a constraint on the size of a part of the web request. AWS WAF uses the Size
, ComparisonOperator
, and FieldToMatch
to build\n\t\t\tan expression in the form of \"Size
\n ComparisonOperator
size in bytes of FieldToMatch
\". If that expression is true, the \n\t\t\tSizeConstraint
is considered to match.
A unique identifier for a SizeConstraintSet
. You use SizeConstraintSetId
to get information about a \n\t\t\tSizeConstraintSet
(see GetSizeConstraintSet), update a SizeConstraintSet
\n\t\t\t(see UpdateSizeConstraintSet), insert a SizeConstraintSet
into a Rule
or \n\t\t\tdelete one from a Rule
(see UpdateRule), and delete a SizeConstraintSet
from AWS WAF \n\t\t\t(see DeleteSizeConstraintSet).
\n SizeConstraintSetId
is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
The name, if any, of the SizeConstraintSet
.
Specifies the parts of web requests that you want to inspect the size of.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nA complex type that contains SizeConstraint
objects, which specify the parts of web requests that you \n\t\t\twant AWS WAF to inspect the size of. If a SizeConstraintSet
contains more than one SizeConstraint
\n\t\t\tobject, a request only needs to match one constraint to be considered a match.
A unique identifier for a SizeConstraintSet
. You use SizeConstraintSetId
to get information about a \n\t\t\tSizeConstraintSet
(see GetSizeConstraintSet), update a SizeConstraintSet
\n\t\t\t(see UpdateSizeConstraintSet), insert a SizeConstraintSet
into a Rule
or \n\t\t\tdelete one from a Rule
(see UpdateRule), and delete a SizeConstraintSet
from AWS WAF \n\t\t\t(see DeleteSizeConstraintSet).
\n SizeConstraintSetId
is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
The name of the SizeConstraintSet
, if any.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe Id
and Name
of a SizeConstraintSet
.
Specify INSERT
to add a SizeConstraintSetUpdate to a SizeConstraintSet. \n\t\t\tUse DELETE
to remove a SizeConstraintSetUpdate
from a SizeConstraintSet
.
Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size
, ComparisonOperator
, and FieldToMatch
to build\n\t\t\tan expression in the form of \"Size
\n ComparisonOperator
size in bytes of FieldToMatch
\". If that expression is true, the\n\t\t\tSizeConstraint
is considered to match.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies the part of a web request that you want to inspect the size of and indicates whether you want to \n\t\t\tadd the specification to a SizeConstraintSet or delete it from a SizeConstraintSet
.
A unique identifier for a SqlInjectionMatchSet
. You use SqlInjectionMatchSetId
to get information about a \n\t\t\tSqlInjectionMatchSet
(see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet
\n\t\t\t(see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet
into a Rule
or \n\t\t\tdelete one from a Rule
(see UpdateRule), and delete a SqlInjectionMatchSet
from AWS WAF \n\t\t\t(see DeleteSqlInjectionMatchSet).
\n SqlInjectionMatchSetId
is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
The name, if any, of the SqlInjectionMatchSet
.
Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nA complex type that contains SqlInjectionMatchTuple
objects, which specify the parts of web requests that you \n\t\t\twant 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 \n\t\t\tSqlInjectionMatchSet
contains more than one SqlInjectionMatchTuple
object, a request needs to \n\t\t\tinclude snippets of SQL code in only one of the specified parts of the request to be considered a match.
A unique identifier for a SqlInjectionMatchSet
. You use SqlInjectionMatchSetId
to get information about a \n\t\t\tSqlInjectionMatchSet
(see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet
\n\t\t\t(see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet
into a Rule
or \n\t\t\tdelete one from a Rule
(see UpdateRule), and delete a SqlInjectionMatchSet
from AWS WAF \n\t\t\t(see DeleteSqlInjectionMatchSet).
\n SqlInjectionMatchSetId
is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
The name of the SqlInjectionMatchSet
, if any, specified by Id
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe Id
and Name
of a SqlInjectionMatchSet
.
Specify INSERT
to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. \n\t\t\tUse DELETE
to remove a SqlInjectionMatchSetUpdate
from a SqlInjectionMatchSet
.
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.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to \n\t\t\tadd the specification to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet
.
Specifies where in a web request to look for snippets of malicious SQL code.
", "smithy.api#required": {} } }, "TextTransformation": { "target": "com.amazonaws.wafregional#TextTransformation", "traits": { "smithy.api#documentation": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on FieldToMatch
before inspecting it for a match.
You can only specify a single type of TextTransformation.
\t\t\t\n\t\t\n CMD_LINE\n
\n\t\tWhen you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:
\n\t\tDelete the following characters: \\ \" ' ^
\nDelete spaces before the following characters: / (
\nReplace the following characters with a space: , ;
\nReplace multiple spaces with one space
\nConvert uppercase letters (A-Z) to lowercase (a-z)
\n\n COMPRESS_WHITE_SPACE\n
\n\t\tUse this option to replace the following characters with a space character (decimal 32):
\n\t\t\\f, formfeed, decimal 12
\n\\t, tab, decimal 9
\n\\n, newline, decimal 10
\n\\r, carriage return, decimal 13
\n\\v, vertical tab, decimal 11
\nnon-breaking space, decimal 160
\n\n COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
\n HTML_ENTITY_DECODE\n
\n\t\tUse this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs \n\t\t\tthe following operations:
Replaces (ampersand)quot;
with \"
\n
Replaces (ampersand)nbsp;
with a non-breaking space, decimal 160
Replaces (ampersand)lt;
with a \"less than\" symbol
Replaces (ampersand)gt;
with >
\n
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;
, with the corresponding \n\t\t\t\tcharacters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;
, with the corresponding \n\t\t\t\tcharacters
\n LOWERCASE\n
\n\t\tUse this option to convert uppercase letters (A-Z) to lowercase (a-z).
\t\t\n\t\t\n URL_DECODE\n
\n\t\tUse this option to decode a URL-encoded value.
\t\t\n\t\t\n NONE\n
\n\t\tSpecify NONE
if you don't want to perform any text transformations.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies 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.
" } }, "com.amazonaws.wafregional#SqlInjectionMatchTuples": { "type": "list", "member": { "target": "com.amazonaws.wafregional#SqlInjectionMatchTuple" } }, "com.amazonaws.wafregional#SubscribedRuleGroupSummaries": { "type": "list", "member": { "target": "com.amazonaws.wafregional#SubscribedRuleGroupSummary" } }, "com.amazonaws.wafregional#SubscribedRuleGroupSummary": { "type": "structure", "members": { "RuleGroupId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "A unique identifier for a RuleGroup
.
A friendly name or description of the RuleGroup
. You can't change the name of a RuleGroup
after you create it.
A friendly name or description for the metrics for this RuleGroup
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nA summary of the rule groups you are subscribed to.
" } }, "com.amazonaws.wafregional#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.wafregional#TagKey", "traits": { "smithy.api#documentation": "", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.wafregional#TagValue", "traits": { "smithy.api#documentation": "", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nA tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
\nTagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
" } }, "com.amazonaws.wafregional#TagInfoForResource": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "" } }, "TagList": { "target": "com.amazonaws.wafregional#TagList", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInformation for a tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
\nTagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
" } }, "com.amazonaws.wafregional#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.wafregional#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.wafregional#TagKey" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.wafregional#TagList": { "type": "list", "member": { "target": "com.amazonaws.wafregional#Tag" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.wafregional#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#TagResourceRequest" }, "output": { "target": "com.amazonaws.wafregional#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFBadRequestException" }, { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidParameterException" }, { "target": "com.amazonaws.wafregional#WAFLimitsExceededException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" }, { "target": "com.amazonaws.wafregional#WAFTagOperationException" }, { "target": "com.amazonaws.wafregional#WAFTagOperationInternalErrorException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nAssociates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
\nTagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
" } }, "com.amazonaws.wafregional#TagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.wafregional#TagList", "traits": { "smithy.api#documentation": "", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.wafregional#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.wafregional#TextTransformation": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NONE", "name": "NONE" }, { "value": "COMPRESS_WHITE_SPACE", "name": "COMPRESS_WHITE_SPACE" }, { "value": "HTML_ENTITY_DECODE", "name": "HTML_ENTITY_DECODE" }, { "value": "LOWERCASE", "name": "LOWERCASE" }, { "value": "CMD_LINE", "name": "CMD_LINE" }, { "value": "URL_DECODE", "name": "URL_DECODE" } ] } }, "com.amazonaws.wafregional#TimeWindow": { "type": "structure", "members": { "StartTime": { "target": "com.amazonaws.wafregional#Timestamp", "traits": { "smithy.api#documentation": "The beginning of the time range from which you want GetSampledRequests
to return a sample of the \n requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. \n UTC format includes the special designator, Z
. For example, \"2016-09-27T14:50Z\"
. \n You can specify any time range in the previous three hours.
The end of the time range from which you want GetSampledRequests
to return a sample of the \n requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. \n UTC format includes the special designator, Z
. For example, \"2016-09-27T14:50Z\"
. \n You can specify any time range in the previous three hours.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nIn a GetSampledRequests request, the StartTime
and EndTime
objects specify the time range \n\t\t\tfor which you want AWS WAF to return a sample of web requests.
You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special \n designator, Z
. For example, \"2016-09-27T14:50Z\"
.
In a GetSampledRequests response, the StartTime
and EndTime
objects specify the time range \n\t\t\tfor which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first \n\t\t\t5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 \n\t\t\trequests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime
\n\t\t\tis the time that AWS WAF received the 5,000th request.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThis is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple
object, \n\t\t\tyou specify the following values:
Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate
object, \n\t\t\t\tyou 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 \n\t\t\t\tthe 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.
\nWhether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
\nFor example, you can add a ByteMatchSetUpdate
object that matches web requests in which User-Agent
headers contain \n\t\t\tthe 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 \n\t\t\t\tUpdateByteMatchSet
request.
Submit an UpdateByteMatchSet
request to specify the part of the request that you want AWS WAF to inspect \n\t\t\t\t(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 \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#UpdateByteMatchSetRequest": { "type": "structure", "members": { "ByteMatchSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The ByteMatchSetId
of the ByteMatchSet that you want to update. ByteMatchSetId
is returned by CreateByteMatchSet and by \n\t\t\tListByteMatchSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } }, "Updates": { "target": "com.amazonaws.wafregional#ByteMatchSetUpdates", "traits": { "smithy.api#documentation": "An array of ByteMatchSetUpdate
objects that you want to insert into or delete from a ByteMatchSet. \n\t\t\tFor more information, see the applicable data types:
\n ByteMatchSetUpdate: Contains Action
and ByteMatchTuple
\n
\n ByteMatchTuple: Contains FieldToMatch
, PositionalConstraint
, TargetString
, \n\t\t\t\tand TextTransformation
\n
\n FieldToMatch: Contains Data
and Type
\n
The ChangeToken
that you used to submit the UpdateByteMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInserts or deletes GeoMatchConstraint objects in an GeoMatchSet
. For each GeoMatchConstraint
object, \n\t\t\tyou specify the following values:
Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint
object, you delete the existing object and add a new one.
The Type
. The only valid value for Type
is Country
.
The Value
, which is a two character code for the country to add to the GeoMatchConstraint
object. Valid codes are listed in GeoMatchConstraint$Value.
To create and configure an GeoMatchSet
, perform the following steps:
Submit a CreateGeoMatchSet request.
\nUse GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateGeoMatchSet request.
Submit an UpdateGeoMatchSet
request to specify the country that you want AWS WAF to watch for.
When you update an GeoMatchSet
, you specify the country that you want to add and/or the country that you want to delete. \n\t\t\tIf you want to change a country, you delete the existing country and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#UpdateGeoMatchSetRequest": { "type": "structure", "members": { "GeoMatchSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The GeoMatchSetId
of the GeoMatchSet that you want to update. GeoMatchSetId
is returned by CreateGeoMatchSet and by \n\t\t\tListGeoMatchSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } }, "Updates": { "target": "com.amazonaws.wafregional#GeoMatchSetUpdates", "traits": { "smithy.api#documentation": "An array of GeoMatchSetUpdate
objects that you want to insert into or delete from an GeoMatchSet.\n\t\t\tFor more information, see the applicable data types:
\n GeoMatchSetUpdate: Contains Action
and GeoMatchConstraint
\n
\n GeoMatchConstraint: Contains Type
and Value
\n
You can have only one Type
and Value
per GeoMatchConstraint
. To add multiple countries, include multiple GeoMatchSetUpdate
objects in your request.
The ChangeToken
that you used to submit the UpdateGeoMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInserts or deletes IPSetDescriptor objects in an\n IPSet
. For each IPSetDescriptor
object, you specify the following\n values:
Whether to insert or delete the object from the array. If you want to change an\n IPSetDescriptor
object, you delete the existing object and add a new\n one.
The IP address version, IPv4
or IPv6
.
The IP address in CIDR notation, for example, 192.0.2.0/24
(for\n the range of IP addresses from 192.0.2.0
to 192.0.2.255
) or\n 192.0.2.44/32
(for the individual IP address\n 192.0.2.44
).
AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS\n WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more\n information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.
\nIPv6 addresses can be represented using any of the following formats:
\n1111:0000:0000:0000:0000:0000:0000:0111/128
\n1111:0:0:0:0:0:0:0111/128
\n1111::0111/128
\n1111::111/128
\nYou use an IPSet
to specify which web requests you want to allow or\n block based on the IP addresses that the requests originated from. For example, if you're\n receiving a lot of requests from one or a small number of IP addresses and you want to\n block the requests, you can create an IPSet
that specifies those IP addresses,\n and then configure AWS WAF to block the requests.
To create and configure an IPSet
, perform the following steps:
Submit a CreateIPSet request.
\nUse GetChangeToken to get the change token that you provide\n in the ChangeToken
parameter of an UpdateIPSet\n request.
Submit an UpdateIPSet
request to specify the IP addresses that you\n want AWS WAF to watch for.
When you update an IPSet
, you specify the IP addresses that you want to\n add and/or the IP addresses that you want to delete. If you want to change an IP address,\n you delete the existing IP address and add the new one.
You can insert a maximum of 1000 addresses in a single\n request.
\nFor more information about how to use the AWS WAF API to allow or block HTTP\n requests, see the AWS WAF\n Developer Guide.
" } }, "com.amazonaws.wafregional#UpdateIPSetRequest": { "type": "structure", "members": { "IPSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The IPSetId
of the IPSet that you want to update. IPSetId
is returned by CreateIPSet and by \n\t\t\tListIPSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } }, "Updates": { "target": "com.amazonaws.wafregional#IPSetUpdates", "traits": { "smithy.api#documentation": "An array of IPSetUpdate
objects that you want to insert into or delete from an IPSet. \n\t\t\tFor more information, see the applicable data types:
\n IPSetUpdate: Contains Action
and IPSetDescriptor
\n
\n IPSetDescriptor: Contains Type
and Value
\n
You can insert a maximum of 1000 addresses in a single request.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#UpdateIPSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the UpdateIPSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInserts or deletes Predicate objects in a rule and updates the\n RateLimit
in the rule.
Each Predicate
object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests\n that you want to block or count. The RateLimit
specifies the number of\n requests every five minutes that triggers the rule.
If you add more than one predicate to a RateBasedRule
, a request must\n match all the predicates and exceed the RateLimit
to be counted or blocked.\n For example, suppose you add the following to a RateBasedRule
:
An IPSet
that matches the IP address 192.0.2.44/32
\n
A ByteMatchSet
that matches BadBot
in the\n User-Agent
header
Further, you specify a\n RateLimit
of 1,000.
You then add the RateBasedRule
to a WebACL
and specify that\n you want to block requests that satisfy the rule. For a request to be blocked, it must come\n from the IP address 192.0.2.44 and the User-Agent
header\n in the request must contain the value BadBot
. Further, requests that match\n these two conditions much be received at a rate of more than 1,000 every five minutes. If\n the rate drops below this limit, AWS WAF no longer blocks the requests.
As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a\n RateBasedRule
:
A ByteMatchSet
with FieldToMatch
of URI
\n
A PositionalConstraint
of STARTS_WITH
\n
A TargetString
of login
\n
Further, you specify a RateLimit
of 1,000.
By adding this RateBasedRule
to a WebACL
, you could limit requests to your login page without affecting the rest of your site.
The RuleId
of the RateBasedRule
that you want to update.\n RuleId
is returned by CreateRateBasedRule
and by ListRateBasedRules.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } }, "Updates": { "target": "com.amazonaws.wafregional#RuleUpdates", "traits": { "smithy.api#documentation": "An array of RuleUpdate
objects that you want to insert into or delete\n from a RateBasedRule.
The maximum number of requests, which have an identical value in the field specified by the RateKey
, allowed in a\n five-minute period. If the number of requests exceeds the RateLimit
and the other\n predicates specified in the rule are also met,\n AWS WAF triggers the action that is specified for this rule.
The ChangeToken
that you used to submit the\n UpdateRateBasedRule
request. You can also use this value to query the\n status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate
object, \n\t\t\tyou specify the following values:
Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate
object, \n\t\t\t\tyou delete the existing object and add a new one.
The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent
header.
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
\nWhether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
\n For example, you can create a RegexPatternSet
that matches any requests with User-Agent
headers \n that contain the string B[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.
To create and configure a RegexMatchSet
, perform the following steps:
Create a RegexMatchSet.
For more information, see CreateRegexMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateRegexMatchSet
request.
Submit an UpdateRegexMatchSet
request to specify the part of the request that you want AWS WAF to inspect \n\t\t\t\t(for example, the header or the URI) and the identifier of the RegexPatternSet
that contain the regular expression patters you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#UpdateRegexMatchSetRequest": { "type": "structure", "members": { "RegexMatchSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The RegexMatchSetId
of the RegexMatchSet that you want to update. RegexMatchSetId
is returned by CreateRegexMatchSet and by \n\t\t\tListRegexMatchSets.
An array of RegexMatchSetUpdate
objects that you want to insert into or delete from a RegexMatchSet. \n\t\t\tFor more information, see RegexMatchTuple.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#UpdateRegexMatchSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the UpdateRegexMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInserts or deletes RegexPatternString
objects in a RegexPatternSet. For each RegexPatternString
object, \n\t\t\tyou specify the following values:
Whether to insert or delete the RegexPatternString
.
The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.
\n For example, you can create a RegexPatternString
such as B[a@]dB[o0]t
. AWS WAF will match this RegexPatternString
to:
BadBot
\n\t\t\t\tBadB0t
\n\t\t\t\tB@dBot
\n\t\t\t\tB@dB0t
\n\t\t\t\tTo create and configure a RegexPatternSet
, perform the following steps:
Create a RegexPatternSet.
For more information, see CreateRegexPatternSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateRegexPatternSet
request.
Submit an UpdateRegexPatternSet
request to specify the regular expression pattern that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#UpdateRegexPatternSetRequest": { "type": "structure", "members": { "RegexPatternSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The RegexPatternSetId
of the RegexPatternSet that you want to update. RegexPatternSetId
is returned by CreateRegexPatternSet and by \n\t\t\tListRegexPatternSets.
An array of RegexPatternSetUpdate
objects that you want to insert into or delete from a RegexPatternSet.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#UpdateRegexPatternSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the UpdateRegexPatternSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInserts or deletes Predicate objects in a Rule
. Each\n Predicate
object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests\n that you want to allow, block, or count. If you add more than one predicate to a\n Rule
, a request must match all of the specifications to be allowed,\n blocked, or counted. For example, suppose\n that\n 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
\n
You then add the Rule
to a WebACL
and specify that you want to block requests that satisfy the Rule
. \n\t\t\tFor a request to be blocked, the User-Agent
header in the request must contain the value BadBot
\n\t\t\t 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 \n\t\t\t\tUpdateRule 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 \n\t\t\tadd the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#UpdateRuleGroup": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#UpdateRuleGroupRequest" }, "output": { "target": "com.amazonaws.wafregional#UpdateRuleGroupResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidOperationException" }, { "target": "com.amazonaws.wafregional#WAFInvalidParameterException" }, { "target": "com.amazonaws.wafregional#WAFLimitsExceededException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentContainerException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" }, { "target": "com.amazonaws.wafregional#WAFStaleDataException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInserts or deletes ActivatedRule objects in a RuleGroup
.
You can only insert REGULAR
rules into a rule group.
You can have a maximum of ten rules per rule group.
\n\t \t \n \t\nTo create and configure a RuleGroup
, perform the following steps:
Create and update the Rules
that you want to include in the RuleGroup
. See CreateRule.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an \n UpdateRuleGroup request.
Submit an UpdateRuleGroup
request to add Rules
to the RuleGroup
.
Create and update a WebACL
that contains the RuleGroup
. See CreateWebACL.
If you want to replace one Rule
with another, you delete the existing one and \n add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n AWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#UpdateRuleGroupRequest": { "type": "structure", "members": { "RuleGroupId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The RuleGroupId
of the RuleGroup that you want to update. RuleGroupId
is returned by CreateRuleGroup and by \n ListRuleGroups.
An array of RuleGroupUpdate
objects that you want to insert into or delete from a \n RuleGroup.
You can only insert REGULAR
rules into a rule group.
\n ActivatedRule|OverrideAction
applies only when updating or adding a RuleGroup
to a WebACL
. In this case you do not use ActivatedRule|Action
. For all other update requests, ActivatedRule|Action
is used instead of ActivatedRule|OverrideAction
.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } } } }, "com.amazonaws.wafregional#UpdateRuleGroupResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the UpdateRuleGroup
request. You can also use this value \n to query the status of the request. For more information, see GetChangeTokenStatus.
The RuleId
of the Rule
that you want to update. RuleId
is returned by \n\t\t\tCreateRule
and by ListRules.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } }, "Updates": { "target": "com.amazonaws.wafregional#RuleUpdates", "traits": { "smithy.api#documentation": "An array of RuleUpdate
objects that you want to insert into or delete from a \n\t\t\tRule. For more information, see the applicable data types:
\n RuleUpdate: Contains Action
and Predicate
\n
\n Predicate: Contains DataId
, Negated
, and Type
\n
\n FieldToMatch: Contains Data
and Type
\n
The ChangeToken
that you used to submit the UpdateRule
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint
object, \n\t\t\tyou specify the following values:
Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate
object, \n\t\t\t\tyou 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 \n\t\t\t\tUser-Agent
header.
Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. \n\t\t\t\tNote that transformations of the request body are not supported because the AWS resource forwards only the first 8192
bytes \n\t\t\t\tof your request to AWS WAF.
You can only specify a single type of TextTransformation.
\nA ComparisonOperator
used for evaluating the selected part of the request against the specified Size
, such as \n\t\t\t\tequals, 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.
\nFor example, you can add a SizeConstraintSetUpdate
object that matches web requests in which the length of the \n\t\t\tUser-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 \n\t\t\t\tUpdateSizeConstraintSet
request.
Submit an UpdateSizeConstraintSet
request to specify the part of the request that you want AWS WAF to inspect \n\t\t\t\t(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 \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#UpdateSizeConstraintSetRequest": { "type": "structure", "members": { "SizeConstraintSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The SizeConstraintSetId
of the SizeConstraintSet that you want to update. SizeConstraintSetId
\n\t\t\tis returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } }, "Updates": { "target": "com.amazonaws.wafregional#SizeConstraintSetUpdates", "traits": { "smithy.api#documentation": "An array of SizeConstraintSetUpdate
objects that you want to insert into or delete from a SizeConstraintSet. \n\t\t\tFor more information, see the applicable data types:
\n SizeConstraintSetUpdate: Contains Action
and SizeConstraint
\n
\n SizeConstraint: Contains FieldToMatch
, TextTransformation
, ComparisonOperator
, \n\t\t\t\tand Size
\n
\n FieldToMatch: Contains Data
and Type
\n
The ChangeToken
that you used to submit the UpdateSizeConstraintSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. \n\t\t\tFor each SqlInjectionMatchTuple
object, you specify the following values:
\n Action
: Whether to insert the object into or delete the object from the array. To change a \n\t\t\t\tSqlInjectionMatchTuple
, you delete the existing object and add a new one.
\n FieldToMatch
: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, \n\t\t\t\tthe name of the header or parameter.
\n TextTransformation
: Which text transformation, if any, to perform on the web request before \n\t\t\t\tinspecting the request for snippets of malicious SQL code.
You can only specify a single type of TextTransformation.
\nYou use SqlInjectionMatchSet
objects to specify which CloudFront\n requests that\n you want to allow, block, or count. For example, if you're receiving\n requests that contain snippets of SQL code in the query string and you want to block the\n requests, you can create a SqlInjectionMatchSet
with the applicable settings,\n and then configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet
, perform the following steps:
Submit a CreateSqlInjectionMatchSet request.
\nUse GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateIPSet request.
Submit an UpdateSqlInjectionMatchSet
request to specify the parts of web requests that you want AWS WAF to \n\t\t\t\tinspect for snippets of SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#UpdateSqlInjectionMatchSetRequest": { "type": "structure", "members": { "SqlInjectionMatchSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The SqlInjectionMatchSetId
of the SqlInjectionMatchSet
that you want to update. \n\t\t\tSqlInjectionMatchSetId
is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } }, "Updates": { "target": "com.amazonaws.wafregional#SqlInjectionMatchSetUpdates", "traits": { "smithy.api#documentation": "An array of SqlInjectionMatchSetUpdate
objects that you want to insert into or delete from a \n\t\t\tSqlInjectionMatchSet. For more information, see the applicable data types:
\n SqlInjectionMatchSetUpdate: Contains Action
and SqlInjectionMatchTuple
\n
\n SqlInjectionMatchTuple: Contains FieldToMatch
and TextTransformation
\n
\n FieldToMatch: Contains Data
and Type
\n
A request to update a SqlInjectionMatchSet.
" } }, "com.amazonaws.wafregional#UpdateSqlInjectionMatchSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the UpdateSqlInjectionMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
The response to an UpdateSqlInjectionMatchSets request.
" } }, "com.amazonaws.wafregional#UpdateWebACL": { "type": "operation", "input": { "target": "com.amazonaws.wafregional#UpdateWebACLRequest" }, "output": { "target": "com.amazonaws.wafregional#UpdateWebACLResponse" }, "errors": [ { "target": "com.amazonaws.wafregional#WAFInternalErrorException" }, { "target": "com.amazonaws.wafregional#WAFInvalidAccountException" }, { "target": "com.amazonaws.wafregional#WAFInvalidOperationException" }, { "target": "com.amazonaws.wafregional#WAFInvalidParameterException" }, { "target": "com.amazonaws.wafregional#WAFLimitsExceededException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentContainerException" }, { "target": "com.amazonaws.wafregional#WAFNonexistentItemException" }, { "target": "com.amazonaws.wafregional#WAFReferencedItemException" }, { "target": "com.amazonaws.wafregional#WAFStaleDataException" }, { "target": "com.amazonaws.wafregional#WAFSubscriptionNotFoundException" } ], "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInserts or deletes ActivatedRule objects in a WebACL
. Each Rule
identifies \n\t\t\tweb 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
. \n\t\t\t\tAWS 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\n or\n delete. If you want to replace one Rule
with another, you delete the\n 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 \n\t\t\t\tthe conditions in the Rule
.
The order in which you want AWS WAF to evaluate the Rules
in a\n WebACL
. If you add more than one Rule
to a\n WebACL
, AWS WAF evaluates each request against the Rules
\n in order based on the value of Priority
. (The Rule
that has\n the lowest value for Priority
is evaluated first.) When a web request\n matches all\n the\n predicates (such as ByteMatchSets
and IPSets
) in a\n Rule
, AWS WAF immediately takes the corresponding action, allow or\n block, and doesn't evaluate the request against the remaining Rules
in\n the WebACL
, if any.
To create and configure a WebACL
, perform the following steps:
Create and update the predicates that you want to include in Rules
. \n\t\t\t\tFor more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, \n\t\t\t\tCreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules
that you want to include in the WebACL
. For more information, see \n\t\t\t\tCreateRule and UpdateRule.
Create a WebACL
. See CreateWebACL.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateWebACL request.
Submit an UpdateWebACL
request to specify the Rules
\n that you want to include in the WebACL
, to specify the default action,\n and to associate the WebACL
with a CloudFront distribution.
The ActivatedRule
can be a rule group. If you specify a rule group\n as your\n ActivatedRule
\n ,\n you can exclude specific rules from that rule group.
If you already have a rule group associated with a web ACL and want to submit\n an UpdateWebACL
request to exclude certain rules from that rule group,\n you must first remove the rule group from the web ACL, the re-insert it again,\n specifying the excluded rules.\n For details,\n see\n ActivatedRule$ExcludedRules\n .\n
Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. \t\t
\t\t\t\n\t\tFor more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#UpdateWebACLRequest": { "type": "structure", "members": { "WebACLId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The WebACLId
of the WebACL that you want to update. WebACLId
is returned by CreateWebACL and by \n\t\t\tListWebACLs.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } }, "Updates": { "target": "com.amazonaws.wafregional#WebACLUpdates", "traits": { "smithy.api#documentation": "An array of updates to make to the WebACL.
\t\t\n\t\tAn array of WebACLUpdate
objects that you want to insert into or delete from a \n\t\t\tWebACL. For more information, see the applicable data types:
\n WebACLUpdate: Contains Action
and ActivatedRule
\n
\n ActivatedRule: Contains Action
,\n OverrideAction
, Priority
, RuleId
, and\n Type
. ActivatedRule|OverrideAction
applies only when\n updating or adding a RuleGroup
to a WebACL
. In this\n case,\n you do not use ActivatedRule|Action
. For all other update requests,\n ActivatedRule|Action
is used instead of\n ActivatedRule|OverrideAction
.
\n WafAction: Contains Type
\n
A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default\n action if a request doesn't match the criteria in any of the rules in a web ACL.
" } } } }, "com.amazonaws.wafregional#UpdateWebACLResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the UpdateWebACL
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nInserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. \n\t\t\tFor each XssMatchTuple
object, you specify the following values:
\n Action
: Whether to insert the object into or delete the object from the\n array. To change an\n XssMatchTuple
, you delete the existing object and add a new\n one.
\n FieldToMatch
: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, \n\t\t\t\tthe name of the header or parameter.
\n TextTransformation
: Which text transformation, if any, to perform on the web request before \n\t\t\t\tinspecting the request for cross-site scripting attacks.
You can only specify a single type of TextTransformation.
\nYou use XssMatchSet
objects to specify which CloudFront requests\n that\n you want to allow, block, or count. For example, if you're receiving\n requests that contain cross-site scripting attacks in the request body and you want to\n block the requests, you can create an XssMatchSet
with the applicable\n settings, and then configure AWS WAF to block the requests.
To create and configure an XssMatchSet
, perform the following steps:
Submit a CreateXssMatchSet request.
\nUse GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an \n\t\t\t\tUpdateIPSet request.
Submit an UpdateXssMatchSet
request to specify the parts of web requests that you want AWS WAF to \n\t\t\t\tinspect for cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the \n\t\t\tAWS WAF Developer Guide.
" } }, "com.amazonaws.wafregional#UpdateXssMatchSetRequest": { "type": "structure", "members": { "XssMatchSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "The XssMatchSetId
of the XssMatchSet
that you want to update. \n\t\t\tXssMatchSetId
is returned by CreateXssMatchSet and by ListXssMatchSets.
The value returned by the most recent call to GetChangeToken.
", "smithy.api#required": {} } }, "Updates": { "target": "com.amazonaws.wafregional#XssMatchSetUpdates", "traits": { "smithy.api#documentation": "An array of XssMatchSetUpdate
objects that you want to insert into or\n delete from an\n XssMatchSet. For more information, see the applicable data\n types:
\n XssMatchSetUpdate: Contains Action
and XssMatchTuple
\n
\n XssMatchTuple: Contains FieldToMatch
and TextTransformation
\n
\n FieldToMatch: Contains Data
and Type
\n
A request to update an XssMatchSet.
" } }, "com.amazonaws.wafregional#UpdateXssMatchSetResponse": { "type": "structure", "members": { "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "The ChangeToken
that you used to submit the UpdateXssMatchSet
request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.
The response to an UpdateXssMatchSets request.
" } }, "com.amazonaws.wafregional#WAFBadRequestException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.wafregional#errorMessage" } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client" } }, "com.amazonaws.wafregional#WAFDisallowedNameException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.wafregional#errorMessage" } }, "traits": { "smithy.api#documentation": "The name specified is invalid.
", "smithy.api#error": "client" } }, "com.amazonaws.wafregional#WAFEntityMigrationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.wafregional#errorMessage" }, "MigrationErrorType": { "target": "com.amazonaws.wafregional#MigrationErrorType" }, "MigrationErrorReason": { "target": "com.amazonaws.wafregional#ErrorReason" } }, "traits": { "smithy.api#documentation": "The operation failed due to a problem with the migration. The failure cause is provided in the exception, in the MigrationErrorType
:
\n ENTITY_NOT_SUPPORTED
- The web ACL has an unsupported entity but the IgnoreUnsupportedType
is not set to true.
\n ENTITY_NOT_FOUND
- The web ACL doesn't exist.
\n S3_BUCKET_NO_PERMISSION
- You don't have permission to perform the PutObject
action to the specified Amazon S3 bucket.
\n S3_BUCKET_NOT_ACCESSIBLE
- The bucket policy doesn't allow AWS WAF to perform the PutObject
action in the bucket.
\n S3_BUCKET_NOT_FOUND
- The S3 bucket doesn't exist.
\n S3_BUCKET_INVALID_REGION
- The S3 bucket is not in the same Region as the web ACL.
\n S3_INTERNAL_ERROR
- AWS WAF failed to create the template in the S3 bucket for another reason.
The operation failed because of a system problem, even though the request was valid. Retry your request.
", "smithy.api#error": "server" } }, "com.amazonaws.wafregional#WAFInvalidAccountException": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
", "smithy.api#error": "client" } }, "com.amazonaws.wafregional#WAFInvalidOperationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.wafregional#errorMessage" } }, "traits": { "smithy.api#documentation": "The operation failed because there was nothing to do. For example:
\n\t\t\tYou 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
\n\t\t\t\t\tisn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists in the \n\t\t\t\t\tspecified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the ByteMatchTuple
\n already exists in the specified WebACL
.
The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
\n\t\t\tYou specified an invalid parameter name.
\nYou specified an invalid value.
\nYou tried to update an object (ByteMatchSet
, IPSet
, Rule
, or WebACL
) \n\t\t\t\t\tusing an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
\n Type
other than \n\t\t\t\t\tALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than IP
.
You tried to update a WebACL
with a WafAction
\n Type
other than \n\t\t\t\t\tALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
\n Type
other than \n\t\t\t\t\tHEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
\n\t\t\t\t\tbut no value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
\n\t\t\t \tThe operation failed because the specified policy is not in the proper format.
\nThe policy is subject to the following restrictions:
\nYou can attach only one policy with each PutPermissionPolicy
request.
The policy must include an Effect
, Action
and Principal
.
\n Effect
must specify Allow
.
The Action
in the policy must be waf:UpdateWebACL
, waf-regional:UpdateWebACL
, waf:GetRuleGroup
and waf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected.
The policy cannot include a Resource
parameter.
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
\nThe user making the request must be the owner of the RuleGroup.
\nYour policy must be composed using IAM Policy version 2012-10-17.
\nThe regular expression (regex) you specified in RegexPatternString
is invalid.
The operation exceeds a resource limit, for example, the maximum number of WebACL
objects that you can create \n\t\t\tfor an AWS account. For more information, see \n\t\t\tLimits in the AWS WAF Developer Guide.
The operation failed because you tried to delete an object that isn't empty. For example:
\n\t\tYou 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 \n\t\t\t\tor 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.
The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:
\n\t\tYou 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
\n\t\t\t\tthat doesn't exist.
The operation failed because the referenced object doesn't exist.
", "smithy.api#error": "client" } }, "com.amazonaws.wafregional#WAFReferencedItemException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.wafregional#errorMessage" } }, "traits": { "smithy.api#documentation": "The operation failed because you tried to delete an object that is still in use. For example:
\n\t\tYou 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
.
AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration
request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole
request, which can lock the role for 15 minutes or more. If you recently made a DeleteServiceLinkedRole
, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
", "smithy.api#error": "client" } }, "com.amazonaws.wafregional#WAFSubscriptionNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.wafregional#errorMessage" } }, "traits": { "smithy.api#documentation": "The specified subscription does not exist.
", "smithy.api#error": "client" } }, "com.amazonaws.wafregional#WAFTagOperationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.wafregional#errorMessage" } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client" } }, "com.amazonaws.wafregional#WAFTagOperationInternalErrorException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.wafregional#errorMessage" } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "server" } }, "com.amazonaws.wafregional#WAFUnavailableEntityException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.wafregional#errorMessage" } }, "traits": { "smithy.api#documentation": "The operation failed because the entity\n referenced is temporarily unavailable. Retry your request.
", "smithy.api#error": "client" } }, "com.amazonaws.wafregional#WafAction": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.wafregional#WafActionType", "traits": { "smithy.api#documentation": "Specifies how you want AWS WAF to respond to requests that match the settings in a Rule
. Valid settings include the following:
\n ALLOW
: AWS WAF allows requests
\n BLOCK
: AWS WAF blocks requests
\n COUNT
: AWS WAF increments a counter of the requests that match all of the conditions in the rule. \n\t\t\t\tAWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT
\n\t\t\t\tfor the default action for a WebACL
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nFor the action that is associated with a rule in a WebACL
, specifies the action that you want AWS WAF to perform when a \n\t\t\tweb request matches all of the conditions in a rule. For the default action in a WebACL
, specifies the action that you want \n\t\t\tAWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL
.
\n COUNT
overrides the action specified by the individual rule within a RuleGroup
. If set to NONE
, the rule's action will take place.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe action to take if any rule within the RuleGroup
matches a request.
A unique identifier for a WebACL
. You use WebACLId
to get information about a WebACL
\n\t\t\t(see GetWebACL), update a WebACL
(see UpdateWebACL), and delete a WebACL
from AWS WAF \n\t\t\t(see DeleteWebACL).
\n WebACLId
is returned by CreateWebACL and by ListWebACLs.
A friendly name or description of the WebACL
. You can't change the name of a WebACL
after you create it.
A friendly name or description for the metrics for this WebACL
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName
after you create the WebACL
.
The action to perform if none of the Rules
contained in the WebACL
match. The action is specified by the \n\t\t\tWafAction object.
An array that contains the action for each Rule
in a WebACL
, the priority of the Rule
, \n\t\t\tand the ID of the Rule
.
Tha Amazon Resource Name (ARN) of the web ACL.
" } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nContains the Rules
that identify the requests that you want to allow, block, or count. In a WebACL
, you also specify a \n\t\t\tdefault action (ALLOW
or BLOCK
), and the action for each Rule
that you add to a \n\t\t\tWebACL
, for example, block requests from specified IP addresses or block requests from specified referrers. \n\t\t\tYou also associate the WebACL
with a CloudFront distribution to identify the requests that you want AWS WAF to filter. \n\t\t\tIf you add more than one Rule
to a WebACL
, a request needs to match only one of the specifications \n\t\t\tto be allowed, blocked, or counted. For more information, see UpdateWebACL.
A unique identifier for a WebACL
. You use WebACLId
to get information about a WebACL
\n\t\t\t(see GetWebACL), update a WebACL
(see UpdateWebACL), and delete a WebACL
from AWS WAF \n\t\t\t(see DeleteWebACL).
\n WebACLId
is returned by CreateWebACL and by ListWebACLs.
A friendly name or description of the WebACL. You can't change the name of a WebACL
after you create it.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nContains the identifier and the name or description of the WebACL.
" } }, "com.amazonaws.wafregional#WebACLUpdate": { "type": "structure", "members": { "Action": { "target": "com.amazonaws.wafregional#ChangeAction", "traits": { "smithy.api#documentation": "Specifies whether to insert a Rule
into or delete a Rule
from a WebACL
.
The ActivatedRule
object in an UpdateWebACL request specifies a Rule
that you want to insert or delete, \n 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
\n (ALLOW
, BLOCK
, or COUNT
).
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies whether to insert a Rule
into or delete a Rule
from a WebACL
.
A unique identifier for an XssMatchSet
. You use XssMatchSetId
to get information about an \n\t\t\tXssMatchSet
(see GetXssMatchSet), update an XssMatchSet
\n\t\t\t(see UpdateXssMatchSet), insert an XssMatchSet
into a Rule
or \n\t\t\tdelete one from a Rule
(see UpdateRule), and delete an XssMatchSet
from AWS WAF \n\t\t\t(see DeleteXssMatchSet).
\n XssMatchSetId
is returned by CreateXssMatchSet and by ListXssMatchSets.
The name, if any, of the XssMatchSet
.
Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nA complex type that contains XssMatchTuple
objects, which specify the parts of web requests that you \n\t\t\twant 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 \n\t\t\tXssMatchSet
contains more than one XssMatchTuple
object, a request needs to \n\t\t\tinclude cross-site scripting attacks in only one of the specified parts of the request to be considered a match.
A unique identifier for an XssMatchSet
. You use XssMatchSetId
to get information about a \n\t\t\tXssMatchSet
(see GetXssMatchSet), update an XssMatchSet
\n\t\t\t(see UpdateXssMatchSet), insert an XssMatchSet
into a Rule
or \n\t\t\tdelete one from a Rule
(see UpdateRule), and delete an XssMatchSet
from AWS WAF \n\t\t\t(see DeleteXssMatchSet).
\n XssMatchSetId
is returned by CreateXssMatchSet and by ListXssMatchSets.
The name of the XssMatchSet
, if any, specified by Id
.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nThe Id
and Name
of an XssMatchSet
.
Specify INSERT
to add an\n XssMatchSetUpdate to an XssMatchSet. Use\n DELETE
to remove an\n XssMatchSetUpdate
from an XssMatchSet
.
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.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to \n\t\t\tadd the specification to an XssMatchSet or delete it from an XssMatchSet
.
Specifies where in a web request to look for cross-site scripting attacks.
", "smithy.api#required": {} } }, "TextTransformation": { "target": "com.amazonaws.wafregional#TextTransformation", "traits": { "smithy.api#documentation": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on FieldToMatch
before inspecting it for a match.
You can only specify a single type of TextTransformation.
\t\t\t\n\t\t\n CMD_LINE\n
\n\t\tWhen you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:
\n\t\tDelete the following characters: \\ \" ' ^
\nDelete spaces before the following characters: / (
\nReplace the following characters with a space: , ;
\nReplace multiple spaces with one space
\nConvert uppercase letters (A-Z) to lowercase (a-z)
\n\n COMPRESS_WHITE_SPACE\n
\n\t\tUse this option to replace the following characters with a space character (decimal 32):
\n\t\t\\f, formfeed, decimal 12
\n\\t, tab, decimal 9
\n\\n, newline, decimal 10
\n\\r, carriage return, decimal 13
\n\\v, vertical tab, decimal 11
\nnon-breaking space, decimal 160
\n\n COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
\n HTML_ENTITY_DECODE\n
\n\t\tUse this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs \n\t\t\tthe following operations:
Replaces (ampersand)quot;
with \"
\n
Replaces (ampersand)nbsp;
with a non-breaking space, decimal 160
Replaces (ampersand)lt;
with a \"less than\" symbol
Replaces (ampersand)gt;
with >
\n
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;
, with the corresponding \n\t\t\t\tcharacters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;
, with the corresponding \n\t\t\t\tcharacters
\n LOWERCASE\n
\n\t\tUse this option to convert uppercase letters (A-Z) to lowercase (a-z).
\t\t\n\t\t\n URL_DECODE\n
\n\t\tUse this option to decode a URL-encoded value.
\t\t\n\t\t\n NONE\n
\n\t\tSpecify NONE
if you don't want to perform any text transformations.
This is AWS WAF Classic documentation. For\n more information, see AWS\n WAF Classic in the developer guide.
\n\n For the latest version of AWS\n WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
\nSpecifies 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.
" } }, "com.amazonaws.wafregional#XssMatchTuples": { "type": "list", "member": { "target": "com.amazonaws.wafregional#XssMatchTuple" } }, "com.amazonaws.wafregional#errorMessage": { "type": "string" } } }