Client library for AWS WAF
Installation and Usage
npm install --save @datafire/amazonaws_waf
let amazonaws_waf = require('@datafire/amazonaws_waf').create({ accessKeyId: "", secretAccessKey: "", region: "" }); .then(data => { console.log(data); });
Description
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
This is the AWS WAF Classic API Reference for using AWS WAF Classic with Amazon CloudFront. The AWS WAF Classic actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the AWS WAF Classic in the developer guide.
Actions
CreateByteMatchSet
amazonaws_waf.CreateByteMatchSet({ "Name": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- Name required
Output
- output CreateByteMatchSetResponse
CreateGeoMatchSet
amazonaws_waf.CreateGeoMatchSet({ "Name": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- Name required
Output
- output CreateGeoMatchSetResponse
CreateIPSet
amazonaws_waf.CreateIPSet({ "Name": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- Name required
Output
- output CreateIPSetResponse
CreateRateBasedRule
amazonaws_waf.CreateRateBasedRule({ "Name": null, "MetricName": null, "RateKey": null, "RateLimit": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- MetricName required
- Name required
- RateKey required
- RateLimit required
- Tags
- items Tag
Output
- output CreateRateBasedRuleResponse
CreateRegexMatchSet
amazonaws_waf.CreateRegexMatchSet({ "Name": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- Name required
Output
- output CreateRegexMatchSetResponse
CreateRegexPatternSet
amazonaws_waf.CreateRegexPatternSet({ "Name": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- Name required
Output
CreateRule
amazonaws_waf.CreateRule({ "Name": null, "MetricName": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- MetricName required
- Name required
- Tags
- items Tag
Output
- output CreateRuleResponse
CreateRuleGroup
amazonaws_waf.CreateRuleGroup({ "Name": null, "MetricName": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- MetricName required
- Name required
- Tags
- items Tag
Output
- output CreateRuleGroupResponse
CreateSizeConstraintSet
amazonaws_waf.CreateSizeConstraintSet({ "Name": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- Name required
Output
CreateSqlInjectionMatchSet
amazonaws_waf.CreateSqlInjectionMatchSet({ "Name": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- Name required
Output
CreateWebACL
amazonaws_waf.CreateWebACL({ "Name": null, "MetricName": null, "DefaultAction": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- DefaultAction required
- Type required
- MetricName required
- Name required
- Tags
- items Tag
Output
- output CreateWebACLResponse
CreateWebACLMigrationStack
amazonaws_waf.CreateWebACLMigrationStack({ "WebACLId": null, "S3BucketName": null, "IgnoreUnsupportedType": null }, context)
Input
- input
object- IgnoreUnsupportedType required
- S3BucketName required
- WebACLId required
Output
CreateXssMatchSet
amazonaws_waf.CreateXssMatchSet({ "Name": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- Name required
Output
- output CreateXssMatchSetResponse
DeleteByteMatchSet
amazonaws_waf.DeleteByteMatchSet({ "ByteMatchSetId": null, "ChangeToken": null }, context)
Input
- input
object- ByteMatchSetId required
- ChangeToken required
Output
- output DeleteByteMatchSetResponse
DeleteGeoMatchSet
amazonaws_waf.DeleteGeoMatchSet({ "GeoMatchSetId": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- GeoMatchSetId required
Output
- output DeleteGeoMatchSetResponse
DeleteIPSet
amazonaws_waf.DeleteIPSet({ "IPSetId": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- IPSetId required
Output
- output DeleteIPSetResponse
DeleteLoggingConfiguration
amazonaws_waf.DeleteLoggingConfiguration({ "ResourceArn": null }, context)
Input
- input
object- ResourceArn required
Output
DeletePermissionPolicy
amazonaws_waf.DeletePermissionPolicy({ "ResourceArn": null }, context)
Input
- input
object- ResourceArn required
Output
DeleteRateBasedRule
amazonaws_waf.DeleteRateBasedRule({ "RuleId": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- RuleId required
Output
- output DeleteRateBasedRuleResponse
DeleteRegexMatchSet
amazonaws_waf.DeleteRegexMatchSet({ "RegexMatchSetId": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- RegexMatchSetId required
Output
- output DeleteRegexMatchSetResponse
DeleteRegexPatternSet
amazonaws_waf.DeleteRegexPatternSet({ "RegexPatternSetId": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- RegexPatternSetId required
Output
DeleteRule
amazonaws_waf.DeleteRule({ "RuleId": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- RuleId required
Output
- output DeleteRuleResponse
DeleteRuleGroup
amazonaws_waf.DeleteRuleGroup({ "RuleGroupId": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- RuleGroupId required
Output
- output DeleteRuleGroupResponse
DeleteSizeConstraintSet
amazonaws_waf.DeleteSizeConstraintSet({ "SizeConstraintSetId": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- SizeConstraintSetId required
Output
DeleteSqlInjectionMatchSet
amazonaws_waf.DeleteSqlInjectionMatchSet({ "SqlInjectionMatchSetId": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- SqlInjectionMatchSetId required
Output
DeleteWebACL
amazonaws_waf.DeleteWebACL({ "WebACLId": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- WebACLId required
Output
- output DeleteWebACLResponse
DeleteXssMatchSet
amazonaws_waf.DeleteXssMatchSet({ "XssMatchSetId": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- XssMatchSetId required
Output
- output DeleteXssMatchSetResponse
GetByteMatchSet
amazonaws_waf.GetByteMatchSet({ "ByteMatchSetId": null }, context)
Input
- input
object- ByteMatchSetId required
Output
- output GetByteMatchSetResponse
GetChangeToken
amazonaws_waf.GetChangeToken({}, context)
Input
- input
object
Output
- output GetChangeTokenResponse
GetChangeTokenStatus
amazonaws_waf.GetChangeTokenStatus({ "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
Output
- output GetChangeTokenStatusResponse
GetGeoMatchSet
amazonaws_waf.GetGeoMatchSet({ "GeoMatchSetId": null }, context)
Input
- input
object- GeoMatchSetId required
Output
- output GetGeoMatchSetResponse
GetIPSet
amazonaws_waf.GetIPSet({ "IPSetId": null }, context)
Input
- input
object- IPSetId required
Output
- output GetIPSetResponse
GetLoggingConfiguration
amazonaws_waf.GetLoggingConfiguration({ "ResourceArn": null }, context)
Input
- input
object- ResourceArn required
Output
GetPermissionPolicy
amazonaws_waf.GetPermissionPolicy({ "ResourceArn": null }, context)
Input
- input
object- ResourceArn required
Output
- output GetPermissionPolicyResponse
GetRateBasedRule
amazonaws_waf.GetRateBasedRule({ "RuleId": null }, context)
Input
- input
object- RuleId required
Output
- output GetRateBasedRuleResponse
GetRateBasedRuleManagedKeys
amazonaws_waf.GetRateBasedRuleManagedKeys({ "RuleId": null }, context)
Input
- input
object- NextMarker
- RuleId required
Output
GetRegexMatchSet
amazonaws_waf.GetRegexMatchSet({ "RegexMatchSetId": null }, context)
Input
- input
object- RegexMatchSetId required
Output
- output GetRegexMatchSetResponse
GetRegexPatternSet
amazonaws_waf.GetRegexPatternSet({ "RegexPatternSetId": null }, context)
Input
- input
object- RegexPatternSetId required
Output
- output GetRegexPatternSetResponse
GetRule
amazonaws_waf.GetRule({ "RuleId": null }, context)
Input
- input
object- RuleId required
Output
- output GetRuleResponse
GetRuleGroup
amazonaws_waf.GetRuleGroup({ "RuleGroupId": null }, context)
Input
- input
object- RuleGroupId required
Output
- output GetRuleGroupResponse
GetSampledRequests
amazonaws_waf.GetSampledRequests({ "WebAclId": null, "RuleId": null, "TimeWindow": null, "MaxItems": null }, context)
Input
- input
object- MaxItems required
- RuleId required
- TimeWindow required
- EndTime required
- StartTime required
- WebAclId required
Output
- output GetSampledRequestsResponse
GetSizeConstraintSet
amazonaws_waf.GetSizeConstraintSet({ "SizeConstraintSetId": null }, context)
Input
- input
object- SizeConstraintSetId required
Output
- output GetSizeConstraintSetResponse
GetSqlInjectionMatchSet
amazonaws_waf.GetSqlInjectionMatchSet({ "SqlInjectionMatchSetId": null }, context)
Input
- input
object- SqlInjectionMatchSetId required
Output
GetWebACL
amazonaws_waf.GetWebACL({ "WebACLId": null }, context)
Input
- input
object- WebACLId required
Output
- output GetWebACLResponse
GetXssMatchSet
amazonaws_waf.GetXssMatchSet({ "XssMatchSetId": null }, context)
Input
- input
object- XssMatchSetId required
Output
- output GetXssMatchSetResponse
ListActivatedRulesInRuleGroup
amazonaws_waf.ListActivatedRulesInRuleGroup({}, context)
Input
- input
object- Limit
- NextMarker
- RuleGroupId
Output
ListByteMatchSets
amazonaws_waf.ListByteMatchSets({}, context)
Input
- input
object- Limit
- NextMarker
Output
- output ListByteMatchSetsResponse
ListGeoMatchSets
amazonaws_waf.ListGeoMatchSets({}, context)
Input
- input
object- Limit
- NextMarker
Output
- output ListGeoMatchSetsResponse
ListIPSets
amazonaws_waf.ListIPSets({}, context)
Input
- input
object- Limit
- NextMarker
Output
- output ListIPSetsResponse
ListLoggingConfigurations
amazonaws_waf.ListLoggingConfigurations({}, context)
Input
- input
object- Limit
- NextMarker
Output
ListRateBasedRules
amazonaws_waf.ListRateBasedRules({}, context)
Input
- input
object- Limit
- NextMarker
Output
- output ListRateBasedRulesResponse
ListRegexMatchSets
amazonaws_waf.ListRegexMatchSets({}, context)
Input
- input
object- Limit
- NextMarker
Output
- output ListRegexMatchSetsResponse
ListRegexPatternSets
amazonaws_waf.ListRegexPatternSets({}, context)
Input
- input
object- Limit
- NextMarker
Output
- output ListRegexPatternSetsResponse
ListRuleGroups
amazonaws_waf.ListRuleGroups({}, context)
Input
- input
object- Limit
- NextMarker
Output
- output ListRuleGroupsResponse
ListRules
amazonaws_waf.ListRules({}, context)
Input
- input
object- Limit
- NextMarker
Output
- output ListRulesResponse
ListSizeConstraintSets
amazonaws_waf.ListSizeConstraintSets({}, context)
Input
- input
object- Limit
- NextMarker
Output
ListSqlInjectionMatchSets
amazonaws_waf.ListSqlInjectionMatchSets({}, context)
Input
- input
object- Limit
- NextMarker
Output
ListSubscribedRuleGroups
amazonaws_waf.ListSubscribedRuleGroups({}, context)
Input
- input
object- Limit
- NextMarker
Output
ListTagsForResource
amazonaws_waf.ListTagsForResource({ "ResourceARN": null }, context)
Input
- input
object- Limit
- NextMarker
- ResourceARN required
Output
- output ListTagsForResourceResponse
ListWebACLs
amazonaws_waf.ListWebACLs({}, context)
Input
- input
object- Limit
- NextMarker
Output
- output ListWebACLsResponse
ListXssMatchSets
amazonaws_waf.ListXssMatchSets({}, context)
Input
- input
object- Limit
- NextMarker
Output
- output ListXssMatchSetsResponse
PutLoggingConfiguration
amazonaws_waf.PutLoggingConfiguration({ "LoggingConfiguration": null }, context)
Input
- input
object- LoggingConfiguration required
- LogDestinationConfigs required
- items ResourceArn
- RedactedFields
- items FieldToMatch
- ResourceArn required
- LogDestinationConfigs required
- LoggingConfiguration required
Output
PutPermissionPolicy
amazonaws_waf.PutPermissionPolicy({ "ResourceArn": null, "Policy": null }, context)
Input
- input
object- Policy required
- ResourceArn required
Output
- output PutPermissionPolicyResponse
TagResource
amazonaws_waf.TagResource({ "ResourceARN": null, "Tags": null }, context)
Input
- input
object- ResourceARN required
- Tags required
- items Tag
Output
- output TagResourceResponse
UntagResource
amazonaws_waf.UntagResource({ "ResourceARN": null, "TagKeys": null }, context)
Input
- input
object- ResourceARN required
- TagKeys required
- items TagKey
Output
- output UntagResourceResponse
UpdateByteMatchSet
amazonaws_waf.UpdateByteMatchSet({ "ByteMatchSetId": null, "ChangeToken": null, "Updates": null }, context)
Input
- input
object- ByteMatchSetId required
- ChangeToken required
- Updates required
- items ByteMatchSetUpdate
Output
- output UpdateByteMatchSetResponse
UpdateGeoMatchSet
amazonaws_waf.UpdateGeoMatchSet({ "GeoMatchSetId": null, "ChangeToken": null, "Updates": null }, context)
Input
- input
object- ChangeToken required
- GeoMatchSetId required
- Updates required
- items GeoMatchSetUpdate
Output
- output UpdateGeoMatchSetResponse
UpdateIPSet
amazonaws_waf.UpdateIPSet({ "IPSetId": null, "ChangeToken": null, "Updates": null }, context)
Input
- input
object- ChangeToken required
- IPSetId required
- Updates required
- items IPSetUpdate
Output
- output UpdateIPSetResponse
UpdateRateBasedRule
amazonaws_waf.UpdateRateBasedRule({ "RuleId": null, "ChangeToken": null, "Updates": null, "RateLimit": null }, context)
Input
- input
object- ChangeToken required
- RateLimit required
- RuleId required
- Updates required
- items RuleUpdate
Output
- output UpdateRateBasedRuleResponse
UpdateRegexMatchSet
amazonaws_waf.UpdateRegexMatchSet({ "RegexMatchSetId": null, "Updates": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- RegexMatchSetId required
- Updates required
- items RegexMatchSetUpdate
Output
- output UpdateRegexMatchSetResponse
UpdateRegexPatternSet
amazonaws_waf.UpdateRegexPatternSet({ "RegexPatternSetId": null, "Updates": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- RegexPatternSetId required
- Updates required
- items RegexPatternSetUpdate
Output
UpdateRule
amazonaws_waf.UpdateRule({ "RuleId": null, "ChangeToken": null, "Updates": null }, context)
Input
- input
object- ChangeToken required
- RuleId required
- Updates required
- items RuleUpdate
Output
- output UpdateRuleResponse
UpdateRuleGroup
amazonaws_waf.UpdateRuleGroup({ "RuleGroupId": null, "Updates": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- RuleGroupId required
- Updates required
- items RuleGroupUpdate
Output
- output UpdateRuleGroupResponse
UpdateSizeConstraintSet
amazonaws_waf.UpdateSizeConstraintSet({ "SizeConstraintSetId": null, "ChangeToken": null, "Updates": null }, context)
Input
- input
object- ChangeToken required
- SizeConstraintSetId required
- Updates required
- items SizeConstraintSetUpdate
Output
UpdateSqlInjectionMatchSet
amazonaws_waf.UpdateSqlInjectionMatchSet({ "SqlInjectionMatchSetId": null, "ChangeToken": null, "Updates": null }, context)
Input
- input
object- ChangeToken required
- SqlInjectionMatchSetId required
- Updates required
Output
UpdateWebACL
amazonaws_waf.UpdateWebACL({ "WebACLId": null, "ChangeToken": null }, context)
Input
- input
object- ChangeToken required
- DefaultAction
- Type required
- Updates
- items WebACLUpdate
- WebACLId required
Output
- output UpdateWebACLResponse
UpdateXssMatchSet
amazonaws_waf.UpdateXssMatchSet({ "XssMatchSetId": null, "ChangeToken": null, "Updates": null }, context)
Input
- input
object- ChangeToken required
- Updates required
- items XssMatchSetUpdate
- XssMatchSetId required
Output
- output UpdateXssMatchSetResponse
Definitions
Action
- Action
string
ActivatedRule
- ActivatedRule
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The
ActivatedRuleobject in an UpdateWebACL request specifies aRulethat you want to insert or delete, the priority of theRulein theWebACL, and the action that you want AWS WAF to take when a web request matches theRule(ALLOW,BLOCK, orCOUNT).To specify whether to insert or delete a
Rule, use theActionparameter in the WebACLUpdate data type.- Action
- Type required
- ExcludedRules
- items ExcludedRule
- OverrideAction
- Type required
- Priority required
- RuleId required
- Type
- Action
ActivatedRules
- ActivatedRules
array- items ActivatedRule
ByteMatchSet
- ByteMatchSet
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
In a GetByteMatchSet request,
ByteMatchSetis a complex type that contains theByteMatchSetIdandNameof aByteMatchSet, and the values that you specified when you updated theByteMatchSet.A complex type that contains
ByteMatchTupleobjects, 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 aByteMatchSetcontains more than oneByteMatchTupleobject, a request needs to match the settings in only oneByteMatchTupleto be considered a match.- ByteMatchSetId required
- ByteMatchTuples required
- items ByteMatchTuple
- Name
ByteMatchSetSummaries
- ByteMatchSetSummaries
array- items ByteMatchSetSummary
ByteMatchSetSummary
- ByteMatchSetSummary
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returned by ListByteMatchSets. Each
ByteMatchSetSummaryobject includes theNameandByteMatchSetIdfor one ByteMatchSet.- ByteMatchSetId required
- Name required
ByteMatchSetUpdate
- ByteMatchSetUpdate
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
In an UpdateByteMatchSet request,
ByteMatchSetUpdatespecifies whether to insert or delete a ByteMatchTuple and includes the settings for theByteMatchTuple.- Action required
- ByteMatchTuple required
- FieldToMatch required
- Data
- Type required
- PositionalConstraint required
- TargetString required
- TextTransformation required
- FieldToMatch required
ByteMatchSetUpdates
- ByteMatchSetUpdates
array- items ByteMatchSetUpdate
ByteMatchTargetString
- ByteMatchTargetString
string
ByteMatchTuple
- ByteMatchTuple
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
- FieldToMatch required
- Data
- Type required
- PositionalConstraint required
- TargetString required
- TextTransformation required
- FieldToMatch required
ByteMatchTuples
- ByteMatchTuples
array- items ByteMatchTuple
ChangeAction
- ChangeAction
string(values: INSERT, DELETE)
ChangeToken
- ChangeToken
string
ChangeTokenStatus
- ChangeTokenStatus
string(values: PROVISIONED, PENDING, INSYNC)
ComparisonOperator
- ComparisonOperator
string(values: EQ, NE, LE, LT, GE, GT)
Country
- Country
string
CreateByteMatchSetRequest
- CreateByteMatchSetRequest
object- ChangeToken required
- Name required
CreateByteMatchSetResponse
- CreateByteMatchSetResponse
object- ByteMatchSet
- ByteMatchSetId required
- ByteMatchTuples required
- items ByteMatchTuple
- Name
- ChangeToken
- ByteMatchSet
CreateGeoMatchSetRequest
- CreateGeoMatchSetRequest
object- ChangeToken required
- Name required
CreateGeoMatchSetResponse
- CreateGeoMatchSetResponse
object- ChangeToken
- GeoMatchSet
- GeoMatchConstraints required
- items GeoMatchConstraint
- GeoMatchSetId required
- Name
- GeoMatchConstraints required
CreateIPSetRequest
- CreateIPSetRequest
object- ChangeToken required
- Name required
CreateIPSetResponse
- CreateIPSetResponse
object- ChangeToken
- IPSet
- IPSetDescriptors required
- items IPSetDescriptor
- IPSetId required
- Name
- IPSetDescriptors required
CreateRateBasedRuleRequest
- CreateRateBasedRuleRequest
object- ChangeToken required
- MetricName required
- Name required
- RateKey required
- RateLimit required
- Tags
- items Tag
CreateRateBasedRuleResponse
- CreateRateBasedRuleResponse
object- ChangeToken
- Rule
- MatchPredicates required
- items Predicate
- MetricName
- Name
- RateKey required
- RateLimit required
- RuleId required
- MatchPredicates required
CreateRegexMatchSetRequest
- CreateRegexMatchSetRequest
object- ChangeToken required
- Name required
CreateRegexMatchSetResponse
- CreateRegexMatchSetResponse
object- ChangeToken
- RegexMatchSet
- Name
- RegexMatchSetId
- RegexMatchTuples
- items RegexMatchTuple
CreateRegexPatternSetRequest
- CreateRegexPatternSetRequest
object- ChangeToken required
- Name required
CreateRegexPatternSetResponse
- CreateRegexPatternSetResponse
object- ChangeToken
- RegexPatternSet
- Name
- RegexPatternSetId required
- RegexPatternStrings required
- items RegexPatternString
CreateRuleGroupRequest
- CreateRuleGroupRequest
object- ChangeToken required
- MetricName required
- Name required
- Tags
- items Tag
CreateRuleGroupResponse
- CreateRuleGroupResponse
object- ChangeToken
- RuleGroup
- MetricName
- Name
- RuleGroupId required
CreateRuleRequest
- CreateRuleRequest
object- ChangeToken required
- MetricName required
- Name required
- Tags
- items Tag
CreateRuleResponse
- CreateRuleResponse
object- ChangeToken
- Rule
- MetricName
- Name
- Predicates required
- items Predicate
- RuleId required
CreateSizeConstraintSetRequest
- CreateSizeConstraintSetRequest
object- ChangeToken required
- Name required
CreateSizeConstraintSetResponse
- CreateSizeConstraintSetResponse
object- ChangeToken
- SizeConstraintSet
- Name
- SizeConstraintSetId required
- SizeConstraints required
- items SizeConstraint
CreateSqlInjectionMatchSetRequest
- CreateSqlInjectionMatchSetRequest
object: A request to create a SqlInjectionMatchSet.- ChangeToken required
- Name required
CreateSqlInjectionMatchSetResponse
- CreateSqlInjectionMatchSetResponse
object: The response to aCreateSqlInjectionMatchSetrequest.- ChangeToken
- SqlInjectionMatchSet
- Name
- SqlInjectionMatchSetId required
- SqlInjectionMatchTuples required
- items SqlInjectionMatchTuple
CreateWebACLMigrationStackRequest
- CreateWebACLMigrationStackRequest
object- IgnoreUnsupportedType required
- S3BucketName required
- WebACLId required
CreateWebACLMigrationStackResponse
- CreateWebACLMigrationStackResponse
object- S3ObjectUrl required
CreateWebACLRequest
- CreateWebACLRequest
object- ChangeToken required
- DefaultAction required
- Type required
- MetricName required
- Name required
- Tags
- items Tag
CreateWebACLResponse
- CreateWebACLResponse
object- ChangeToken
- WebACL
- DefaultAction required
- Type required
- MetricName
- Name
- Rules required
- items ActivatedRule
- WebACLArn
- WebACLId required
- DefaultAction required
CreateXssMatchSetRequest
- CreateXssMatchSetRequest
object: A request to create an XssMatchSet.- ChangeToken required
- Name required
CreateXssMatchSetResponse
- CreateXssMatchSetResponse
object: The response to aCreateXssMatchSetrequest.- ChangeToken
- XssMatchSet
- Name
- XssMatchSetId required
- XssMatchTuples required
- items XssMatchTuple
DeleteByteMatchSetRequest
- DeleteByteMatchSetRequest
object- ByteMatchSetId required
- ChangeToken required
DeleteByteMatchSetResponse
- DeleteByteMatchSetResponse
object- ChangeToken
DeleteGeoMatchSetRequest
- DeleteGeoMatchSetRequest
object- ChangeToken required
- GeoMatchSetId required
DeleteGeoMatchSetResponse
- DeleteGeoMatchSetResponse
object- ChangeToken
DeleteIPSetRequest
- DeleteIPSetRequest
object- ChangeToken required
- IPSetId required
DeleteIPSetResponse
- DeleteIPSetResponse
object- ChangeToken
DeleteLoggingConfigurationRequest
- DeleteLoggingConfigurationRequest
object- ResourceArn required
DeleteLoggingConfigurationResponse
- DeleteLoggingConfigurationResponse
object
DeletePermissionPolicyRequest
- DeletePermissionPolicyRequest
object- ResourceArn required
DeletePermissionPolicyResponse
- DeletePermissionPolicyResponse
object
DeleteRateBasedRuleRequest
- DeleteRateBasedRuleRequest
object- ChangeToken required
- RuleId required
DeleteRateBasedRuleResponse
- DeleteRateBasedRuleResponse
object- ChangeToken
DeleteRegexMatchSetRequest
- DeleteRegexMatchSetRequest
object- ChangeToken required
- RegexMatchSetId required
DeleteRegexMatchSetResponse
- DeleteRegexMatchSetResponse
object- ChangeToken
DeleteRegexPatternSetRequest
- DeleteRegexPatternSetRequest
object- ChangeToken required
- RegexPatternSetId required
DeleteRegexPatternSetResponse
- DeleteRegexPatternSetResponse
object- ChangeToken
DeleteRuleGroupRequest
- DeleteRuleGroupRequest
object- ChangeToken required
- RuleGroupId required
DeleteRuleGroupResponse
- DeleteRuleGroupResponse
object- ChangeToken
DeleteRuleRequest
- DeleteRuleRequest
object- ChangeToken required
- RuleId required
DeleteRuleResponse
- DeleteRuleResponse
object- ChangeToken
DeleteSizeConstraintSetRequest
- DeleteSizeConstraintSetRequest
object- ChangeToken required
- SizeConstraintSetId required
DeleteSizeConstraintSetResponse
- DeleteSizeConstraintSetResponse
object- ChangeToken
DeleteSqlInjectionMatchSetRequest
- DeleteSqlInjectionMatchSetRequest
object: A request to delete a SqlInjectionMatchSet from AWS WAF.- ChangeToken required
- SqlInjectionMatchSetId required
DeleteSqlInjectionMatchSetResponse
- DeleteSqlInjectionMatchSetResponse
object: The response to a request to delete a SqlInjectionMatchSet from AWS WAF.- ChangeToken
DeleteWebACLRequest
- DeleteWebACLRequest
object- ChangeToken required
- WebACLId required
DeleteWebACLResponse
- DeleteWebACLResponse
object- ChangeToken
DeleteXssMatchSetRequest
- DeleteXssMatchSetRequest
object: A request to delete an XssMatchSet from AWS WAF.- ChangeToken required
- XssMatchSetId required
DeleteXssMatchSetResponse
- DeleteXssMatchSetResponse
object: The response to a request to delete an XssMatchSet from AWS WAF.- ChangeToken
ExcludedRule
- ExcludedRule
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The rule to exclude from a rule group. This is applicable only when the
ActivatedRulerefers to aRuleGroup. The rule must belong to theRuleGroupthat is specified by theActivatedRule.- RuleId required
ExcludedRules
- ExcludedRules
array- items ExcludedRule
FieldToMatch
- FieldToMatch
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies where in a web request to look for
TargetString.- Data
- Type required
GeoMatchConstraint
- GeoMatchConstraint
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The country from which web requests originate that you want AWS WAF to search for.
- Type required
- Value required
GeoMatchConstraintType
- GeoMatchConstraintType
string(values: Country)
GeoMatchConstraintValue
- GeoMatchConstraintValue
string(values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW)
GeoMatchConstraints
- GeoMatchConstraints
array- items GeoMatchConstraint
GeoMatchSet
- GeoMatchSet
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains one or more countries that AWS WAF will search for.
- GeoMatchConstraints required
- items GeoMatchConstraint
- GeoMatchSetId required
- Name
- GeoMatchConstraints required
GeoMatchSetSummaries
- GeoMatchSetSummaries
array- items GeoMatchSetSummary
GeoMatchSetSummary
- GeoMatchSetSummary
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains the identifier and the name of the
GeoMatchSet.- GeoMatchSetId required
- Name required
GeoMatchSetUpdate
- GeoMatchSetUpdate
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the type of update to perform to an GeoMatchSet with UpdateGeoMatchSet.
- Action required
- GeoMatchConstraint required
- Type required
- Value required
GeoMatchSetUpdates
- GeoMatchSetUpdates
array- items GeoMatchSetUpdate
GetByteMatchSetRequest
- GetByteMatchSetRequest
object- ByteMatchSetId required
GetByteMatchSetResponse
- GetByteMatchSetResponse
object- ByteMatchSet
- ByteMatchSetId required
- ByteMatchTuples required
- items ByteMatchTuple
- Name
- ByteMatchSet
GetChangeTokenRequest
- GetChangeTokenRequest
object
GetChangeTokenResponse
- GetChangeTokenResponse
object- ChangeToken
GetChangeTokenStatusRequest
- GetChangeTokenStatusRequest
object- ChangeToken required
GetChangeTokenStatusResponse
- GetChangeTokenStatusResponse
object- ChangeTokenStatus
GetGeoMatchSetRequest
- GetGeoMatchSetRequest
object- GeoMatchSetId required
GetGeoMatchSetResponse
- GetGeoMatchSetResponse
object- GeoMatchSet
- GeoMatchConstraints required
- items GeoMatchConstraint
- GeoMatchSetId required
- Name
- GeoMatchConstraints required
- GeoMatchSet
GetIPSetRequest
- GetIPSetRequest
object- IPSetId required
GetIPSetResponse
- GetIPSetResponse
object- IPSet
- IPSetDescriptors required
- items IPSetDescriptor
- IPSetId required
- Name
- IPSetDescriptors required
- IPSet
GetLoggingConfigurationRequest
- GetLoggingConfigurationRequest
object- ResourceArn required
GetLoggingConfigurationResponse
- GetLoggingConfigurationResponse
object- LoggingConfiguration
- LogDestinationConfigs required
- items ResourceArn
- RedactedFields
- items FieldToMatch
- ResourceArn required
- LogDestinationConfigs required
- LoggingConfiguration
GetPermissionPolicyRequest
- GetPermissionPolicyRequest
object- ResourceArn required
GetPermissionPolicyResponse
- GetPermissionPolicyResponse
object- Policy
GetRateBasedRuleManagedKeysRequest
- GetRateBasedRuleManagedKeysRequest
object- NextMarker
- RuleId required
GetRateBasedRuleManagedKeysResponse
- GetRateBasedRuleManagedKeysResponse
object- ManagedKeys
- items ManagedKey
- NextMarker
- ManagedKeys
GetRateBasedRuleRequest
- GetRateBasedRuleRequest
object- RuleId required
GetRateBasedRuleResponse
- GetRateBasedRuleResponse
object- Rule
- MatchPredicates required
- items Predicate
- MetricName
- Name
- RateKey required
- RateLimit required
- RuleId required
- MatchPredicates required
- Rule
GetRegexMatchSetRequest
- GetRegexMatchSetRequest
object- RegexMatchSetId required
GetRegexMatchSetResponse
- GetRegexMatchSetResponse
object- RegexMatchSet
- Name
- RegexMatchSetId
- RegexMatchTuples
- items RegexMatchTuple
- RegexMatchSet
GetRegexPatternSetRequest
- GetRegexPatternSetRequest
object- RegexPatternSetId required
GetRegexPatternSetResponse
- GetRegexPatternSetResponse
object- RegexPatternSet
- Name
- RegexPatternSetId required
- RegexPatternStrings required
- items RegexPatternString
- RegexPatternSet
GetRuleGroupRequest
- GetRuleGroupRequest
object- RuleGroupId required
GetRuleGroupResponse
- GetRuleGroupResponse
object- RuleGroup
- MetricName
- Name
- RuleGroupId required
- RuleGroup
GetRuleRequest
- GetRuleRequest
object- RuleId required
GetRuleResponse
- GetRuleResponse
object- Rule
- MetricName
- Name
- Predicates required
- items Predicate
- RuleId required
- Rule
GetSampledRequestsMaxItems
- GetSampledRequestsMaxItems
integer
GetSampledRequestsRequest
- GetSampledRequestsRequest
object- MaxItems required
- RuleId required
- TimeWindow required
- EndTime required
- StartTime required
- WebAclId required
GetSampledRequestsResponse
- GetSampledRequestsResponse
object- PopulationSize
- SampledRequests
- items SampledHTTPRequest
- TimeWindow
- EndTime required
- StartTime required
GetSizeConstraintSetRequest
- GetSizeConstraintSetRequest
object- SizeConstraintSetId required
GetSizeConstraintSetResponse
- GetSizeConstraintSetResponse
object- SizeConstraintSet
- Name
- SizeConstraintSetId required
- SizeConstraints required
- items SizeConstraint
- SizeConstraintSet
GetSqlInjectionMatchSetRequest
- GetSqlInjectionMatchSetRequest
object: A request to get a SqlInjectionMatchSet.- SqlInjectionMatchSetId required
GetSqlInjectionMatchSetResponse
- GetSqlInjectionMatchSetResponse
object: The response to a GetSqlInjectionMatchSet request.- SqlInjectionMatchSet
- Name
- SqlInjectionMatchSetId required
- SqlInjectionMatchTuples required
- items SqlInjectionMatchTuple
- SqlInjectionMatchSet
GetWebACLRequest
- GetWebACLRequest
object- WebACLId required
GetWebACLResponse
- GetWebACLResponse
object- WebACL
- DefaultAction required
- Type required
- MetricName
- Name
- Rules required
- items ActivatedRule
- WebACLArn
- WebACLId required
- DefaultAction required
- WebACL
GetXssMatchSetRequest
- GetXssMatchSetRequest
object: A request to get an XssMatchSet.- XssMatchSetId required
GetXssMatchSetResponse
- GetXssMatchSetResponse
object: The response to a GetXssMatchSet request.- XssMatchSet
- Name
- XssMatchSetId required
- XssMatchTuples required
- items XssMatchTuple
- XssMatchSet
HTTPHeader
- HTTPHeader
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The response from a GetSampledRequests request includes an
HTTPHeadercomplex type that appears asHeadersin the response syntax.HTTPHeadercontains the names and values of all of the headers that appear in one of the web requests that were returned byGetSampledRequests.- Name
- Value
HTTPHeaders
- HTTPHeaders
array- items HTTPHeader
HTTPMethod
- HTTPMethod
string
HTTPRequest
- HTTPRequest
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The response from a GetSampledRequests request includes an
HTTPRequestcomplex type that appears asRequestin the response syntax.HTTPRequestcontains information about one of the web requests that were returned byGetSampledRequests.- ClientIP
- Country
- HTTPVersion
- Headers
- items HTTPHeader
- Method
- URI
HTTPVersion
- HTTPVersion
string
HeaderName
- HeaderName
string
HeaderValue
- HeaderValue
string
IPSet
- IPSet
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.
To specify an individual IP address, you specify the four-part IP address followed by a
/32, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.- IPSetDescriptors required
- items IPSetDescriptor
- IPSetId required
- Name
- IPSetDescriptors required
IPSetDescriptor
- IPSetDescriptor
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the IP address type (
IPV4orIPV6) and the IP address range (in CIDR format) that web requests originate from.- Type required
- Value required
IPSetDescriptorType
- IPSetDescriptorType
string(values: IPV4, IPV6)
IPSetDescriptorValue
- IPSetDescriptorValue
string
IPSetDescriptors
- IPSetDescriptors
array- items IPSetDescriptor
IPSetSummaries
- IPSetSummaries
array- items IPSetSummary
IPSetSummary
- IPSetSummary
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains the identifier and the name of the
IPSet.- IPSetId required
- Name required
IPSetUpdate
- IPSetUpdate
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the type of update to perform to an IPSet with UpdateIPSet.
- Action required
- IPSetDescriptor required
- Type required
- Value required
IPSetUpdates
- IPSetUpdates
array- items IPSetUpdate
IPString
- IPString
string
IgnoreUnsupportedType
- IgnoreUnsupportedType
boolean
ListActivatedRulesInRuleGroupRequest
- ListActivatedRulesInRuleGroupRequest
object- Limit
- NextMarker
- RuleGroupId
ListActivatedRulesInRuleGroupResponse
- ListActivatedRulesInRuleGroupResponse
object- ActivatedRules
- items ActivatedRule
- NextMarker
- ActivatedRules
ListByteMatchSetsRequest
- ListByteMatchSetsRequest
object- Limit
- NextMarker
ListByteMatchSetsResponse
- ListByteMatchSetsResponse
object- ByteMatchSets
- items ByteMatchSetSummary
- NextMarker
- ByteMatchSets
ListGeoMatchSetsRequest
- ListGeoMatchSetsRequest
object- Limit
- NextMarker
ListGeoMatchSetsResponse
- ListGeoMatchSetsResponse
object- GeoMatchSets
- items GeoMatchSetSummary
- NextMarker
- GeoMatchSets
ListIPSetsRequest
- ListIPSetsRequest
object- Limit
- NextMarker
ListIPSetsResponse
- ListIPSetsResponse
object- IPSets
- items IPSetSummary
- NextMarker
- IPSets
ListLoggingConfigurationsRequest
- ListLoggingConfigurationsRequest
object- Limit
- NextMarker
ListLoggingConfigurationsResponse
- ListLoggingConfigurationsResponse
object- LoggingConfigurations
- items LoggingConfiguration
- NextMarker
- LoggingConfigurations
ListRateBasedRulesRequest
- ListRateBasedRulesRequest
object- Limit
- NextMarker
ListRateBasedRulesResponse
- ListRateBasedRulesResponse
object- NextMarker
- Rules
- items RuleSummary
ListRegexMatchSetsRequest
- ListRegexMatchSetsRequest
object- Limit
- NextMarker
ListRegexMatchSetsResponse
- ListRegexMatchSetsResponse
object- NextMarker
- RegexMatchSets
- items RegexMatchSetSummary
ListRegexPatternSetsRequest
- ListRegexPatternSetsRequest
object- Limit
- NextMarker
ListRegexPatternSetsResponse
- ListRegexPatternSetsResponse
object- NextMarker
- RegexPatternSets
- items RegexPatternSetSummary
ListRuleGroupsRequest
- ListRuleGroupsRequest
object- Limit
- NextMarker
ListRuleGroupsResponse
- ListRuleGroupsResponse
object- NextMarker
- RuleGroups
- items RuleGroupSummary
ListRulesRequest
- ListRulesRequest
object- Limit
- NextMarker
ListRulesResponse
- ListRulesResponse
object- NextMarker
- Rules
- items RuleSummary
ListSizeConstraintSetsRequest
- ListSizeConstraintSetsRequest
object- Limit
- NextMarker
ListSizeConstraintSetsResponse
- ListSizeConstraintSetsResponse
object- NextMarker
- SizeConstraintSets
- items SizeConstraintSetSummary
ListSqlInjectionMatchSetsRequest
- ListSqlInjectionMatchSetsRequest
object: A request to list the SqlInjectionMatchSet objects created by the current AWS account.- Limit
- NextMarker
ListSqlInjectionMatchSetsResponse
- ListSqlInjectionMatchSetsResponse
object: The response to a ListSqlInjectionMatchSets request.- NextMarker
- SqlInjectionMatchSets
ListSubscribedRuleGroupsRequest
- ListSubscribedRuleGroupsRequest
object- Limit
- NextMarker
ListSubscribedRuleGroupsResponse
- ListSubscribedRuleGroupsResponse
object- NextMarker
- RuleGroups
ListTagsForResourceRequest
- ListTagsForResourceRequest
object- Limit
- NextMarker
- ResourceARN required
ListTagsForResourceResponse
- ListTagsForResourceResponse
object- NextMarker
- TagInfoForResource
- ResourceARN
- TagList
- items Tag
ListWebACLsRequest
- ListWebACLsRequest
object- Limit
- NextMarker
ListWebACLsResponse
- ListWebACLsResponse
object- NextMarker
- WebACLs
- items WebACLSummary
ListXssMatchSetsRequest
- ListXssMatchSetsRequest
object: A request to list the XssMatchSet objects created by the current AWS account.- Limit
- NextMarker
ListXssMatchSetsResponse
- ListXssMatchSetsResponse
object: The response to a ListXssMatchSets request.- NextMarker
- XssMatchSets
- items XssMatchSetSummary
LogDestinationConfigs
- LogDestinationConfigs
array- items ResourceArn
LoggingConfiguration
- LoggingConfiguration
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The Amazon Kinesis Data Firehose,
RedactedFieldsinformation, and the web ACL Amazon Resource Name (ARN).- LogDestinationConfigs required
- items ResourceArn
- RedactedFields
- items FieldToMatch
- ResourceArn required
- LogDestinationConfigs required
LoggingConfigurations
- LoggingConfigurations
array- items LoggingConfiguration
ManagedKey
- ManagedKey
string
ManagedKeys
- ManagedKeys
array- items ManagedKey
MatchFieldData
- MatchFieldData
string
MatchFieldType
- MatchFieldType
string(values: URI, QUERY_STRING, HEADER, METHOD, BODY, SINGLE_QUERY_ARG, ALL_QUERY_ARGS)
MetricName
- MetricName
string
Negated
- Negated
boolean
NextMarker
- NextMarker
string
PaginationLimit
- PaginationLimit
integer
PolicyString
- PolicyString
string
PopulationSize
- PopulationSize
integer
PositionalConstraint
- PositionalConstraint
string(values: EXACTLY, STARTS_WITH, ENDS_WITH, CONTAINS, CONTAINS_WORD)
Predicate
- Predicate
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a
Ruleand, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.- DataId required
- Negated required
- Type required
PredicateType
- PredicateType
string(values: IPMatch, ByteMatch, SqlInjectionMatch, GeoMatch, SizeConstraint, XssMatch, RegexMatch)
Predicates
- Predicates
array- items Predicate
PutLoggingConfigurationRequest
- PutLoggingConfigurationRequest
object- LoggingConfiguration required
- LogDestinationConfigs required
- items ResourceArn
- RedactedFields
- items FieldToMatch
- ResourceArn required
- LogDestinationConfigs required
- LoggingConfiguration required
PutLoggingConfigurationResponse
- PutLoggingConfigurationResponse
object- LoggingConfiguration
- LogDestinationConfigs required
- items ResourceArn
- RedactedFields
- items FieldToMatch
- ResourceArn required
- LogDestinationConfigs required
- LoggingConfiguration
PutPermissionPolicyRequest
- PutPermissionPolicyRequest
object- Policy required
- ResourceArn required
PutPermissionPolicyResponse
- PutPermissionPolicyResponse
object
RateBasedRule
- RateBasedRule
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A
RateBasedRuleis identical to a regular Rule, with one addition: aRateBasedRulecounts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create aRateBasedRulethat includes the following conditions:-
The requests come from 192.0.2.44.
-
They contain the value
BadBotin theUser-Agentheader.
In the rule, you also define the rate limit as 1,000.
Requests that meet both of these conditions and exceed 1,000 requests every five minutes trigger the rule's action (block or count), which is defined in the web ACL.
- MatchPredicates required
- items Predicate
- MetricName
- Name
- RateKey required
- RateLimit required
- RuleId required
-
RateKey
- RateKey
string(values: IP)
RateLimit
- RateLimit
integer
RedactedFields
- RedactedFields
array- items FieldToMatch
RegexMatchSet
- RegexMatchSet
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
In a GetRegexMatchSet request,
RegexMatchSetis a complex type that contains theRegexMatchSetIdandNameof aRegexMatchSet, and the values that you specified when you updated theRegexMatchSet.The values are contained in a
RegexMatchTupleobject, 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 aRegexMatchSetcontains more than oneRegexMatchTupleobject, a request needs to match the settings in only oneByteMatchTupleto be considered a match.- Name
- RegexMatchSetId
- RegexMatchTuples
- items RegexMatchTuple
RegexMatchSetSummaries
- RegexMatchSetSummaries
array- items RegexMatchSetSummary
RegexMatchSetSummary
- RegexMatchSetSummary
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returned by ListRegexMatchSets. Each
RegexMatchSetSummaryobject includes theNameandRegexMatchSetIdfor one RegexMatchSet.- Name required
- RegexMatchSetId required
RegexMatchSetUpdate
- RegexMatchSetUpdate
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
In an UpdateRegexMatchSet request,
RegexMatchSetUpdatespecifies whether to insert or delete a RegexMatchTuple and includes the settings for theRegexMatchTuple.- Action required
- RegexMatchTuple required
- FieldToMatch required
- Data
- Type required
- RegexPatternSetId required
- TextTransformation required
- FieldToMatch required
RegexMatchSetUpdates
- RegexMatchSetUpdates
array- items RegexMatchSetUpdate
RegexMatchTuple
- RegexMatchTuple
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each
RegexMatchTupleobject 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-Agentheader. -
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
-
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
- FieldToMatch required
- Data
- Type required
- RegexPatternSetId required
- TextTransformation required
-
RegexMatchTuples
- RegexMatchTuples
array- items RegexMatchTuple
RegexPatternSet
- RegexPatternSet
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The
RegexPatternSetspecifies the regular expression (regex) pattern that you want AWS WAF to search for, such asB[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.- Name
- RegexPatternSetId required
- RegexPatternStrings required
- items RegexPatternString
RegexPatternSetSummaries
- RegexPatternSetSummaries
array- items RegexPatternSetSummary
RegexPatternSetSummary
- RegexPatternSetSummary
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returned by ListRegexPatternSets. Each
RegexPatternSetSummaryobject includes theNameandRegexPatternSetIdfor one RegexPatternSet.- Name required
- RegexPatternSetId required
RegexPatternSetUpdate
- RegexPatternSetUpdate
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
In an UpdateRegexPatternSet request,
RegexPatternSetUpdatespecifies whether to insert or delete aRegexPatternStringand includes the settings for theRegexPatternString.- Action required
- RegexPatternString required
RegexPatternSetUpdates
- RegexPatternSetUpdates
array- items RegexPatternSetUpdate
RegexPatternString
- RegexPatternString
string
RegexPatternStrings
- RegexPatternStrings
array- items RegexPatternString
ResourceArn
- ResourceArn
string
ResourceId
- ResourceId
string
ResourceName
- ResourceName
string
Rule
- Rule
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a
Rulethat includes the following predicates:-
An
IPSetthat causes AWS WAF to search for web requests that originate from the IP address192.0.2.44 -
A
ByteMatchSetthat causes AWS WAF to search for web requests for which the value of theUser-Agentheader isBadBot.
To match the settings in this
Rule, a request must originate from192.0.2.44AND include aUser-Agentheader for which the value isBadBot.- MetricName
- Name
- Predicates required
- items Predicate
- RuleId required
-
RuleGroup
- RuleGroup
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A collection of predefined rules that you can add to a web ACL.
Rule groups are subject to the following limits:
-
Three rule groups per account. You can request an increase to this limit by contacting customer support.
-
One rule group per web ACL.
-
Ten rules per rule group.
- MetricName
- Name
- RuleGroupId required
-
RuleGroupSummaries
- RuleGroupSummaries
array- items RuleGroupSummary
RuleGroupSummary
- RuleGroupSummary
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains the identifier and the friendly name or description of the
RuleGroup.- Name required
- RuleGroupId required
RuleGroupUpdate
- RuleGroupUpdate
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies an
ActivatedRuleand indicates whether you want to add it to aRuleGroupor delete it from aRuleGroup.- Action required
- ActivatedRule required
- Action
- Type required
- ExcludedRules
- items ExcludedRule
- OverrideAction
- Type required
- Priority required
- RuleId required
- Type
- Action
RuleGroupUpdates
- RuleGroupUpdates
array- items RuleGroupUpdate
RulePriority
- RulePriority
integer
RuleSummaries
- RuleSummaries
array- items RuleSummary
RuleSummary
- RuleSummary
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains the identifier and the friendly name or description of the
Rule.- Name required
- RuleId required
RuleUpdate
- RuleUpdate
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies a
Predicate(such as anIPSet) and indicates whether you want to add it to aRuleor delete it from aRule.- Action required
- Predicate required
- DataId required
- Negated required
- Type required
RuleUpdates
- RuleUpdates
array- items RuleUpdate
S3BucketName
- S3BucketName
string
S3ObjectUrl
- S3ObjectUrl
string
SampleWeight
- SampleWeight
integer
SampledHTTPRequest
- SampledHTTPRequest
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The response from a GetSampledRequests request includes a
SampledHTTPRequestscomplex type that appears asSampledRequestsin the response syntax.SampledHTTPRequestscontains oneSampledHTTPRequestobject for each web request that is returned byGetSampledRequests.- Action
- Request required
- ClientIP
- Country
- HTTPVersion
- Headers
- items HTTPHeader
- Method
- URI
- RuleWithinRuleGroup
- Timestamp
- Weight required
SampledHTTPRequests
- SampledHTTPRequests
array- items SampledHTTPRequest
Size
- Size
integer
SizeConstraint
- SizeConstraint
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies a constraint on the size of a part of the web request. AWS WAF uses the
Size,ComparisonOperator, andFieldToMatchto build an expression in the form of "SizeComparisonOperatorsize in bytes ofFieldToMatch". If that expression is true, theSizeConstraintis considered to match.- ComparisonOperator required
- FieldToMatch required
- Data
- Type required
- Size required
- TextTransformation required
SizeConstraintSet
- SizeConstraintSet
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A complex type that contains
SizeConstraintobjects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If aSizeConstraintSetcontains more than oneSizeConstraintobject, a request only needs to match one constraint to be considered a match.- Name
- SizeConstraintSetId required
- SizeConstraints required
- items SizeConstraint
SizeConstraintSetSummaries
- SizeConstraintSetSummaries
array- items SizeConstraintSetSummary
SizeConstraintSetSummary
- SizeConstraintSetSummary
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The
IdandNameof aSizeConstraintSet.- Name required
- SizeConstraintSetId required
SizeConstraintSetUpdate
- SizeConstraintSetUpdate
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the part of a web request that you want to inspect the size of and indicates whether you want to add the specification to a SizeConstraintSet or delete it from a
SizeConstraintSet.- Action required
- SizeConstraint required
- ComparisonOperator required
- FieldToMatch required
- Data
- Type required
- Size required
- TextTransformation required
SizeConstraintSetUpdates
- SizeConstraintSetUpdates
array- items SizeConstraintSetUpdate
SizeConstraints
- SizeConstraints
array- items SizeConstraint
SqlInjectionMatchSet
- SqlInjectionMatchSet
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A complex type that contains
SqlInjectionMatchTupleobjects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If aSqlInjectionMatchSetcontains more than oneSqlInjectionMatchTupleobject, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match.- Name
- SqlInjectionMatchSetId required
- SqlInjectionMatchTuples required
- items SqlInjectionMatchTuple
SqlInjectionMatchSetSummaries
- SqlInjectionMatchSetSummaries
array
SqlInjectionMatchSetSummary
- SqlInjectionMatchSetSummary
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The
IdandNameof aSqlInjectionMatchSet.- Name required
- SqlInjectionMatchSetId required
SqlInjectionMatchSetUpdate
- SqlInjectionMatchSetUpdate
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the specification to a SqlInjectionMatchSet or delete it from a
SqlInjectionMatchSet.- Action required
- SqlInjectionMatchTuple required
- FieldToMatch required
- Data
- Type required
- TextTransformation required
- FieldToMatch required
SqlInjectionMatchSetUpdates
- SqlInjectionMatchSetUpdates
array
SqlInjectionMatchTuple
- SqlInjectionMatchTuple
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.
- FieldToMatch required
- Data
- Type required
- TextTransformation required
- FieldToMatch required
SqlInjectionMatchTuples
- SqlInjectionMatchTuples
array- items SqlInjectionMatchTuple
SubscribedRuleGroupSummaries
- SubscribedRuleGroupSummaries
array
SubscribedRuleGroupSummary
- SubscribedRuleGroupSummary
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A summary of the rule groups you are subscribed to.
- MetricName required
- Name required
- RuleGroupId required
Tag
- Tag
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
- Key required
- Value required
TagInfoForResource
- TagInfoForResource
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Information for a tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
- ResourceARN
- TagList
- items Tag
TagKey
- TagKey
string
TagKeyList
- TagKeyList
array- items TagKey
TagList
- TagList
array- items Tag
TagResourceRequest
- TagResourceRequest
object- ResourceARN required
- Tags required
- items Tag
TagResourceResponse
- TagResourceResponse
object
TagValue
- TagValue
string
TextTransformation
- TextTransformation
string(values: NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE)
TimeWindow
- TimeWindow
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
In a GetSampledRequests request, the
StartTimeandEndTimeobjects specify the time range for which you want AWS WAF to return a sample of web requests.You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator,
Z. For example,"2016-09-27T14:50Z".In a GetSampledRequests response, the
StartTimeandEndTimeobjects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case,EndTimeis the time that AWS WAF received the 5,000th request.- EndTime required
- StartTime required
Timestamp
- Timestamp
string
URIString
- URIString
string
UntagResourceRequest
- UntagResourceRequest
object- ResourceARN required
- TagKeys required
- items TagKey
UntagResourceResponse
- UntagResourceResponse
object
UpdateByteMatchSetRequest
- UpdateByteMatchSetRequest
object- ByteMatchSetId required
- ChangeToken required
- Updates required
- items ByteMatchSetUpdate
UpdateByteMatchSetResponse
- UpdateByteMatchSetResponse
object- ChangeToken
UpdateGeoMatchSetRequest
- UpdateGeoMatchSetRequest
object- ChangeToken required
- GeoMatchSetId required
- Updates required
- items GeoMatchSetUpdate
UpdateGeoMatchSetResponse
- UpdateGeoMatchSetResponse
object- ChangeToken
UpdateIPSetRequest
- UpdateIPSetRequest
object- ChangeToken required
- IPSetId required
- Updates required
- items IPSetUpdate
UpdateIPSetResponse
- UpdateIPSetResponse
object- ChangeToken
UpdateRateBasedRuleRequest
- UpdateRateBasedRuleRequest
object- ChangeToken required
- RateLimit required
- RuleId required
- Updates required
- items RuleUpdate
UpdateRateBasedRuleResponse
- UpdateRateBasedRuleResponse
object- ChangeToken
UpdateRegexMatchSetRequest
- UpdateRegexMatchSetRequest
object- ChangeToken required
- RegexMatchSetId required
- Updates required
- items RegexMatchSetUpdate
UpdateRegexMatchSetResponse
- UpdateRegexMatchSetResponse
object- ChangeToken
UpdateRegexPatternSetRequest
- UpdateRegexPatternSetRequest
object- ChangeToken required
- RegexPatternSetId required
- Updates required
- items RegexPatternSetUpdate
UpdateRegexPatternSetResponse
- UpdateRegexPatternSetResponse
object- ChangeToken
UpdateRuleGroupRequest
- UpdateRuleGroupRequest
object- ChangeToken required
- RuleGroupId required
- Updates required
- items RuleGroupUpdate
UpdateRuleGroupResponse
- UpdateRuleGroupResponse
object- ChangeToken
UpdateRuleRequest
- UpdateRuleRequest
object- ChangeToken required
- RuleId required
- Updates required
- items RuleUpdate
UpdateRuleResponse
- UpdateRuleResponse
object- ChangeToken
UpdateSizeConstraintSetRequest
- UpdateSizeConstraintSetRequest
object- ChangeToken required
- SizeConstraintSetId required
- Updates required
- items SizeConstraintSetUpdate
UpdateSizeConstraintSetResponse
- UpdateSizeConstraintSetResponse
object- ChangeToken
UpdateSqlInjectionMatchSetRequest
- UpdateSqlInjectionMatchSetRequest
object: A request to update a SqlInjectionMatchSet.- ChangeToken required
- SqlInjectionMatchSetId required
- Updates required
UpdateSqlInjectionMatchSetResponse
- UpdateSqlInjectionMatchSetResponse
object: The response to an UpdateSqlInjectionMatchSets request.- ChangeToken
UpdateWebACLRequest
- UpdateWebACLRequest
object- ChangeToken required
- DefaultAction
- Type required
- Updates
- items WebACLUpdate
- WebACLId required
UpdateWebACLResponse
- UpdateWebACLResponse
object- ChangeToken
UpdateXssMatchSetRequest
- UpdateXssMatchSetRequest
object: A request to update an XssMatchSet.- ChangeToken required
- Updates required
- items XssMatchSetUpdate
- XssMatchSetId required
UpdateXssMatchSetResponse
- UpdateXssMatchSetResponse
object: The response to an UpdateXssMatchSets request.- ChangeToken
WAFBadRequestException
WAFDisallowedNameException
WAFEntityMigrationException
WAFInternalErrorException
WAFInvalidAccountException
WAFInvalidOperationException
WAFInvalidParameterException
WAFInvalidPermissionPolicyException
WAFInvalidRegexPatternException
WAFLimitsExceededException
WAFNonEmptyEntityException
WAFNonexistentContainerException
WAFNonexistentItemException
WAFReferencedItemException
WAFServiceLinkedRoleErrorException
WAFStaleDataException
WAFSubscriptionNotFoundException
WAFTagOperationException
WAFTagOperationInternalErrorException
WafAction
- WafAction
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
For the action that is associated with a rule in a
WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in aWebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in aWebACL.- Type required
WafActionType
- WafActionType
string(values: BLOCK, ALLOW, COUNT)
WafOverrideAction
- WafOverrideAction
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The action to take if any rule within the
RuleGroupmatches a request.- Type required
WafOverrideActionType
- WafOverrideActionType
string(values: NONE, COUNT)
WafRuleType
- WafRuleType
string(values: REGULAR, RATE_BASED, GROUP)
WebACL
- WebACL
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains the
Rulesthat identify the requests that you want to allow, block, or count. In aWebACL, you also specify a default action (ALLOWorBLOCK), and the action for eachRulethat you add to aWebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate theWebACLwith a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than oneRuleto aWebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.- DefaultAction required
- Type required
- MetricName
- Name
- Rules required
- items ActivatedRule
- WebACLArn
- WebACLId required
- DefaultAction required
WebACLSummaries
- WebACLSummaries
array- items WebACLSummary
WebACLSummary
- WebACLSummary
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains the identifier and the name or description of the WebACL.
- Name required
- WebACLId required
WebACLUpdate
- WebACLUpdate
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies whether to insert a
Ruleinto or delete aRulefrom aWebACL.- Action required
- ActivatedRule required
- Action
- Type required
- ExcludedRules
- items ExcludedRule
- OverrideAction
- Type required
- Priority required
- RuleId required
- Type
- Action
WebACLUpdates
- WebACLUpdates
array- items WebACLUpdate
XssMatchSet
- XssMatchSet
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A complex type that contains
XssMatchTupleobjects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If aXssMatchSetcontains more than oneXssMatchTupleobject, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.- Name
- XssMatchSetId required
- XssMatchTuples required
- items XssMatchTuple
XssMatchSetSummaries
- XssMatchSetSummaries
array- items XssMatchSetSummary
XssMatchSetSummary
- XssMatchSetSummary
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The
IdandNameof anXssMatchSet.- Name required
- XssMatchSetId required
XssMatchSetUpdate
- XssMatchSetUpdate
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the specification to an XssMatchSet or delete it from an
XssMatchSet.- Action required
- XssMatchTuple required
- FieldToMatch required
- Data
- Type required
- TextTransformation required
- FieldToMatch required
XssMatchSetUpdates
- XssMatchSetUpdates
array- items XssMatchSetUpdate
XssMatchTuple
- XssMatchTuple
object:This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.
- FieldToMatch required
- Data
- Type required
- TextTransformation required
- FieldToMatch required
XssMatchTuples
- XssMatchTuples
array- items XssMatchTuple