Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-waf

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.

Installation

NPM

npm install @aws-sdk/client-waf

Yarn

yarn add @aws-sdk/client-waf

pnpm

pnpm add @aws-sdk/client-waf

Types

Type Name	Type
ActivatedRule	Interface
ByteMatchSet	Interface
ByteMatchSetSummary	Interface
ByteMatchSetUpdate	Interface
ByteMatchTuple	Interface
ChangeAction	TypeAlias
ChangeActionenum	Variable
ChangeTokenStatus	TypeAlias
ChangeTokenStatusenum	Variable
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
ComparisonOperator	TypeAlias
ComparisonOperatorenum	Variable
CreateByteMatchSetCommand	Class
CreateByteMatchSetCommandInput	Interface
CreateByteMatchSetCommandOutput	Interface
CreateByteMatchSetRequest	Interface
CreateByteMatchSetResponse	Interface
CreateGeoMatchSetCommand	Class
CreateGeoMatchSetCommandInput	Interface
CreateGeoMatchSetCommandOutput	Interface
CreateGeoMatchSetRequest	Interface
CreateGeoMatchSetResponse	Interface
CreateIPSetCommand	Class
CreateIPSetCommandInput	Interface
CreateIPSetCommandOutput	Interface
CreateIPSetRequest	Interface
CreateIPSetResponse	Interface
CreateRateBasedRuleCommand	Class
CreateRateBasedRuleCommandInput	Interface
CreateRateBasedRuleCommandOutput	Interface
CreateRateBasedRuleRequest	Interface
CreateRateBasedRuleResponse	Interface
CreateRegexMatchSetCommand	Class
CreateRegexMatchSetCommandInput	Interface
CreateRegexMatchSetCommandOutput	Interface
CreateRegexMatchSetRequest	Interface
CreateRegexMatchSetResponse	Interface
CreateRegexPatternSetCommand	Class
CreateRegexPatternSetCommandInput	Interface
CreateRegexPatternSetCommandOutput	Interface
CreateRegexPatternSetRequest	Interface
CreateRegexPatternSetResponse	Interface
CreateRuleCommand	Class
CreateRuleCommandInput	Interface
CreateRuleCommandOutput	Interface
CreateRuleGroupCommand	Class
CreateRuleGroupCommandInput	Interface
CreateRuleGroupCommandOutput	Interface
CreateRuleGroupRequest	Interface
CreateRuleGroupResponse	Interface
CreateRuleRequest	Interface
CreateRuleResponse	Interface
CreateSizeConstraintSetCommand	Class
CreateSizeConstraintSetCommandInput	Interface
CreateSizeConstraintSetCommandOutput	Interface
CreateSizeConstraintSetRequest	Interface
CreateSizeConstraintSetResponse	Interface
CreateSqlInjectionMatchSetCommand	Class
CreateSqlInjectionMatchSetCommandInput	Interface
CreateSqlInjectionMatchSetCommandOutput	Interface
CreateSqlInjectionMatchSetRequest	Interface
CreateSqlInjectionMatchSetResponse	Interface
CreateWebACLCommand	Class
CreateWebACLCommandInput	Interface
CreateWebACLCommandOutput	Interface
CreateWebACLMigrationStackCommand	Class
CreateWebACLMigrationStackCommandInput	Interface
CreateWebACLMigrationStackCommandOutput	Interface
CreateWebACLMigrationStackRequest	Interface
CreateWebACLMigrationStackResponse	Interface
CreateWebACLRequest	Interface
CreateWebACLResponse	Interface
CreateXssMatchSetCommand	Class
CreateXssMatchSetCommandInput	Interface
CreateXssMatchSetCommandOutput	Interface
CreateXssMatchSetRequest	Interface
CreateXssMatchSetResponse	Interface
DeleteByteMatchSetCommand	Class
DeleteByteMatchSetCommandInput	Interface
DeleteByteMatchSetCommandOutput	Interface
DeleteByteMatchSetRequest	Interface
DeleteByteMatchSetResponse	Interface
DeleteGeoMatchSetCommand	Class
DeleteGeoMatchSetCommandInput	Interface
DeleteGeoMatchSetCommandOutput	Interface
DeleteGeoMatchSetRequest	Interface
DeleteGeoMatchSetResponse	Interface
DeleteIPSetCommand	Class
DeleteIPSetCommandInput	Interface
DeleteIPSetCommandOutput	Interface
DeleteIPSetRequest	Interface
DeleteIPSetResponse	Interface
DeleteLoggingConfigurationCommand	Class
DeleteLoggingConfigurationCommandInput	Interface
DeleteLoggingConfigurationCommandOutput	Interface
DeleteLoggingConfigurationRequest	Interface
DeleteLoggingConfigurationResponse	Interface
DeletePermissionPolicyCommand	Class
DeletePermissionPolicyCommandInput	Interface
DeletePermissionPolicyCommandOutput	Interface
DeletePermissionPolicyRequest	Interface
DeletePermissionPolicyResponse	Interface
DeleteRateBasedRuleCommand	Class
DeleteRateBasedRuleCommandInput	Interface
DeleteRateBasedRuleCommandOutput	Interface
DeleteRateBasedRuleRequest	Interface
DeleteRateBasedRuleResponse	Interface
DeleteRegexMatchSetCommand	Class
DeleteRegexMatchSetCommandInput	Interface
DeleteRegexMatchSetCommandOutput	Interface
DeleteRegexMatchSetRequest	Interface
DeleteRegexMatchSetResponse	Interface
DeleteRegexPatternSetCommand	Class
DeleteRegexPatternSetCommandInput	Interface
DeleteRegexPatternSetCommandOutput	Interface
DeleteRegexPatternSetRequest	Interface
DeleteRegexPatternSetResponse	Interface
DeleteRuleCommand	Class
DeleteRuleCommandInput	Interface
DeleteRuleCommandOutput	Interface
DeleteRuleGroupCommand	Class
DeleteRuleGroupCommandInput	Interface
DeleteRuleGroupCommandOutput	Interface
DeleteRuleGroupRequest	Interface
DeleteRuleGroupResponse	Interface
DeleteRuleRequest	Interface
DeleteRuleResponse	Interface
DeleteSizeConstraintSetCommand	Class
DeleteSizeConstraintSetCommandInput	Interface
DeleteSizeConstraintSetCommandOutput	Interface
DeleteSizeConstraintSetRequest	Interface
DeleteSizeConstraintSetResponse	Interface
DeleteSqlInjectionMatchSetCommand	Class
DeleteSqlInjectionMatchSetCommandInput	Interface
DeleteSqlInjectionMatchSetCommandOutput	Interface
DeleteSqlInjectionMatchSetRequest	Interface
DeleteSqlInjectionMatchSetResponse	Interface
DeleteWebACLCommand	Class
DeleteWebACLCommandInput	Interface
DeleteWebACLCommandOutput	Interface
DeleteWebACLRequest	Interface
DeleteWebACLResponse	Interface
DeleteXssMatchSetCommand	Class
DeleteXssMatchSetCommandInput	Interface
DeleteXssMatchSetCommandOutput	Interface
DeleteXssMatchSetRequest	Interface
DeleteXssMatchSetResponse	Interface
ExcludedRule	Interface
FieldToMatch	Interface
GeoMatchConstraint	Interface
GeoMatchConstraintType	TypeAlias
GeoMatchConstraintTypeenum	Variable
GeoMatchConstraintValue	TypeAlias
GeoMatchConstraintValueenum	Variable
GeoMatchSet	Interface
GeoMatchSetSummary	Interface
GeoMatchSetUpdate	Interface
GetByteMatchSetCommand	Class
GetByteMatchSetCommandInput	Interface
GetByteMatchSetCommandOutput	Interface
GetByteMatchSetRequest	Interface
GetByteMatchSetResponse	Interface
GetChangeTokenCommand	Class
GetChangeTokenCommandInput	Interface
GetChangeTokenCommandOutput	Interface
GetChangeTokenRequest	Interface
GetChangeTokenResponse	Interface
GetChangeTokenStatusCommand	Class
GetChangeTokenStatusCommandInput	Interface
GetChangeTokenStatusCommandOutput	Interface
GetChangeTokenStatusRequest	Interface
GetChangeTokenStatusResponse	Interface
GetGeoMatchSetCommand	Class
GetGeoMatchSetCommandInput	Interface
GetGeoMatchSetCommandOutput	Interface
GetGeoMatchSetRequest	Interface
GetGeoMatchSetResponse	Interface
GetIPSetCommand	Class
GetIPSetCommandInput	Interface
GetIPSetCommandOutput	Interface
GetIPSetRequest	Interface
GetIPSetResponse	Interface
GetLoggingConfigurationCommand	Class
GetLoggingConfigurationCommandInput	Interface
GetLoggingConfigurationCommandOutput	Interface
GetLoggingConfigurationRequest	Interface
GetLoggingConfigurationResponse	Interface
GetPermissionPolicyCommand	Class
GetPermissionPolicyCommandInput	Interface
GetPermissionPolicyCommandOutput	Interface
GetPermissionPolicyRequest	Interface
GetPermissionPolicyResponse	Interface
GetRateBasedRuleCommand	Class
GetRateBasedRuleCommandInput	Interface
GetRateBasedRuleCommandOutput	Interface
GetRateBasedRuleManagedKeysCommand	Class
GetRateBasedRuleManagedKeysCommandInput	Interface
GetRateBasedRuleManagedKeysCommandOutput	Interface
GetRateBasedRuleManagedKeysRequest	Interface
GetRateBasedRuleManagedKeysResponse	Interface
GetRateBasedRuleRequest	Interface
GetRateBasedRuleResponse	Interface
GetRegexMatchSetCommand	Class
GetRegexMatchSetCommandInput	Interface
GetRegexMatchSetCommandOutput	Interface
GetRegexMatchSetRequest	Interface
GetRegexMatchSetResponse	Interface
GetRegexPatternSetCommand	Class
GetRegexPatternSetCommandInput	Interface
GetRegexPatternSetCommandOutput	Interface
GetRegexPatternSetRequest	Interface
GetRegexPatternSetResponse	Interface
GetRuleCommand	Class
GetRuleCommandInput	Interface
GetRuleCommandOutput	Interface
GetRuleGroupCommand	Class
GetRuleGroupCommandInput	Interface
GetRuleGroupCommandOutput	Interface
GetRuleGroupRequest	Interface
GetRuleGroupResponse	Interface
GetRuleRequest	Interface
GetRuleResponse	Interface
GetSampledRequestsCommand	Class
GetSampledRequestsCommandInput	Interface
GetSampledRequestsCommandOutput	Interface
GetSampledRequestsRequest	Interface
GetSampledRequestsResponse	Interface
GetSizeConstraintSetCommand	Class
GetSizeConstraintSetCommandInput	Interface
GetSizeConstraintSetCommandOutput	Interface
GetSizeConstraintSetRequest	Interface
GetSizeConstraintSetResponse	Interface
GetSqlInjectionMatchSetCommand	Class
GetSqlInjectionMatchSetCommandInput	Interface
GetSqlInjectionMatchSetCommandOutput	Interface
GetSqlInjectionMatchSetRequest	Interface
GetSqlInjectionMatchSetResponse	Interface
GetWebACLCommand	Class
GetWebACLCommandInput	Interface
GetWebACLCommandOutput	Interface
GetWebACLRequest	Interface
GetWebACLResponse	Interface
GetXssMatchSetCommand	Class
GetXssMatchSetCommandInput	Interface
GetXssMatchSetCommandOutput	Interface
GetXssMatchSetRequest	Interface
GetXssMatchSetResponse	Interface
HTTPHeader	Interface
HTTPRequest	Interface
IPSet	Interface
IPSetDescriptor	Interface
IPSetDescriptorType	TypeAlias
IPSetDescriptorTypeenum	Variable
IPSetSummary	Interface
IPSetUpdate	Interface
ListActivatedRulesInRuleGroupCommand	Class
ListActivatedRulesInRuleGroupCommandInput	Interface
ListActivatedRulesInRuleGroupCommandOutput	Interface
ListActivatedRulesInRuleGroupRequest	Interface
ListActivatedRulesInRuleGroupResponse	Interface
ListByteMatchSetsCommand	Class
ListByteMatchSetsCommandInput	Interface
ListByteMatchSetsCommandOutput	Interface
ListByteMatchSetsRequest	Interface
ListByteMatchSetsResponse	Interface
ListGeoMatchSetsCommand	Class
ListGeoMatchSetsCommandInput	Interface
ListGeoMatchSetsCommandOutput	Interface
ListGeoMatchSetsRequest	Interface
ListGeoMatchSetsResponse	Interface
ListIPSetsCommand	Class
ListIPSetsCommandInput	Interface
ListIPSetsCommandOutput	Interface
ListIPSetsRequest	Interface
ListIPSetsResponse	Interface
ListLoggingConfigurationsCommand	Class
ListLoggingConfigurationsCommandInput	Interface
ListLoggingConfigurationsCommandOutput	Interface
ListLoggingConfigurationsRequest	Interface
ListLoggingConfigurationsResponse	Interface
ListRateBasedRulesCommand	Class
ListRateBasedRulesCommandInput	Interface
ListRateBasedRulesCommandOutput	Interface
ListRateBasedRulesRequest	Interface
ListRateBasedRulesResponse	Interface
ListRegexMatchSetsCommand	Class
ListRegexMatchSetsCommandInput	Interface
ListRegexMatchSetsCommandOutput	Interface
ListRegexMatchSetsRequest	Interface
ListRegexMatchSetsResponse	Interface
ListRegexPatternSetsCommand	Class
ListRegexPatternSetsCommandInput	Interface
ListRegexPatternSetsCommandOutput	Interface
ListRegexPatternSetsRequest	Interface
ListRegexPatternSetsResponse	Interface
ListRuleGroupsCommand	Class
ListRuleGroupsCommandInput	Interface
ListRuleGroupsCommandOutput	Interface
ListRuleGroupsRequest	Interface
ListRuleGroupsResponse	Interface
ListRulesCommand	Class
ListRulesCommandInput	Interface
ListRulesCommandOutput	Interface
ListRulesRequest	Interface
ListRulesResponse	Interface
ListSizeConstraintSetsCommand	Class
ListSizeConstraintSetsCommandInput	Interface
ListSizeConstraintSetsCommandOutput	Interface
ListSizeConstraintSetsRequest	Interface
ListSizeConstraintSetsResponse	Interface
ListSqlInjectionMatchSetsCommand	Class
ListSqlInjectionMatchSetsCommandInput	Interface
ListSqlInjectionMatchSetsCommandOutput	Interface
ListSqlInjectionMatchSetsRequest	Interface
ListSqlInjectionMatchSetsResponse	Interface
ListSubscribedRuleGroupsCommand	Class
ListSubscribedRuleGroupsCommandInput	Interface
ListSubscribedRuleGroupsCommandOutput	Interface
ListSubscribedRuleGroupsRequest	Interface
ListSubscribedRuleGroupsResponse	Interface
ListTagsForResourceCommand	Class
ListTagsForResourceCommandInput	Interface
ListTagsForResourceCommandOutput	Interface
ListTagsForResourceRequest	Interface
ListTagsForResourceResponse	Interface
ListWebACLsCommand	Class
ListWebACLsCommandInput	Interface
ListWebACLsCommandOutput	Interface
ListWebACLsRequest	Interface
ListWebACLsResponse	Interface
ListXssMatchSetsCommand	Class
ListXssMatchSetsCommandInput	Interface
ListXssMatchSetsCommandOutput	Interface
ListXssMatchSetsRequest	Interface
ListXssMatchSetsResponse	Interface
LoggingConfiguration	Interface
MatchFieldType	TypeAlias
MatchFieldTypeenum	Variable
MigrationErrorType	TypeAlias
MigrationErrorTypeenum	Variable
ParameterExceptionField	TypeAlias
ParameterExceptionFieldenum	Variable
ParameterExceptionReason	TypeAlias
ParameterExceptionReasonenum	Variable
PositionalConstraint	TypeAlias
PositionalConstraintenum	Variable
Predicate	Interface
PredicateType	TypeAlias
PredicateTypeenum	Variable
PutLoggingConfigurationCommand	Class
PutLoggingConfigurationCommandInput	Interface
PutLoggingConfigurationCommandOutput	Interface
PutLoggingConfigurationRequest	Interface
PutLoggingConfigurationResponse	Interface
PutPermissionPolicyCommand	Class
PutPermissionPolicyCommandInput	Interface
PutPermissionPolicyCommandOutput	Interface
PutPermissionPolicyRequest	Interface
PutPermissionPolicyResponse	Interface
RateBasedRule	Interface
RateKey	TypeAlias
RateKeyenum	Variable
RegexMatchSet	Interface
RegexMatchSetSummary	Interface
RegexMatchSetUpdate	Interface
RegexMatchTuple	Interface
RegexPatternSet	Interface
RegexPatternSetSummary	Interface
RegexPatternSetUpdate	Interface
Rule	Interface
RuleGroup	Interface
RuleGroupSummary	Interface
RuleGroupUpdate	Interface
RuleSummary	Interface
RuleUpdate	Interface
RuntimeExtension	Interface
SampledHTTPRequest	Interface
ServiceInputTypes	TypeAlias
ServiceOutputTypes	TypeAlias
SizeConstraint	Interface
SizeConstraintSet	Interface
SizeConstraintSetSummary	Interface
SizeConstraintSetUpdate	Interface
SqlInjectionMatchSet	Interface
SqlInjectionMatchSetSummary	Interface
SqlInjectionMatchSetUpdate	Interface
SqlInjectionMatchTuple	Interface
SubscribedRuleGroupSummary	Interface
Tag	Interface
TagInfoForResource	Interface
TagResourceCommand	Class
TagResourceCommandInput	Interface
TagResourceCommandOutput	Interface
TagResourceRequest	Interface
TagResourceResponse	Interface
TextTransformation	TypeAlias
TextTransformationenum	Variable
TimeWindow	Interface
UntagResourceCommand	Class
UntagResourceCommandInput	Interface
UntagResourceCommandOutput	Interface
UntagResourceRequest	Interface
UntagResourceResponse	Interface
UpdateByteMatchSetCommand	Class
UpdateByteMatchSetCommandInput	Interface
UpdateByteMatchSetCommandOutput	Interface
UpdateByteMatchSetRequest	Interface
UpdateByteMatchSetResponse	Interface
UpdateGeoMatchSetCommand	Class
UpdateGeoMatchSetCommandInput	Interface
UpdateGeoMatchSetCommandOutput	Interface
UpdateGeoMatchSetRequest	Interface
UpdateGeoMatchSetResponse	Interface
UpdateIPSetCommand	Class
UpdateIPSetCommandInput	Interface
UpdateIPSetCommandOutput	Interface
UpdateIPSetRequest	Interface
UpdateIPSetResponse	Interface
UpdateRateBasedRuleCommand	Class
UpdateRateBasedRuleCommandInput	Interface
UpdateRateBasedRuleCommandOutput	Interface
UpdateRateBasedRuleRequest	Interface
UpdateRateBasedRuleResponse	Interface
UpdateRegexMatchSetCommand	Class
UpdateRegexMatchSetCommandInput	Interface
UpdateRegexMatchSetCommandOutput	Interface
UpdateRegexMatchSetRequest	Interface
UpdateRegexMatchSetResponse	Interface
UpdateRegexPatternSetCommand	Class
UpdateRegexPatternSetCommandInput	Interface
UpdateRegexPatternSetCommandOutput	Interface
UpdateRegexPatternSetRequest	Interface
UpdateRegexPatternSetResponse	Interface
UpdateRuleCommand	Class
UpdateRuleCommandInput	Interface
UpdateRuleCommandOutput	Interface
UpdateRuleGroupCommand	Class
UpdateRuleGroupCommandInput	Interface
UpdateRuleGroupCommandOutput	Interface
UpdateRuleGroupRequest	Interface
UpdateRuleGroupResponse	Interface
UpdateRuleRequest	Interface
UpdateRuleResponse	Interface
UpdateSizeConstraintSetCommand	Class
UpdateSizeConstraintSetCommandInput	Interface
UpdateSizeConstraintSetCommandOutput	Interface
UpdateSizeConstraintSetRequest	Interface
UpdateSizeConstraintSetResponse	Interface
UpdateSqlInjectionMatchSetCommand	Class
UpdateSqlInjectionMatchSetCommandInput	Interface
UpdateSqlInjectionMatchSetCommandOutput	Interface
UpdateSqlInjectionMatchSetRequest	Interface
UpdateSqlInjectionMatchSetResponse	Interface
UpdateWebACLCommand	Class
UpdateWebACLCommandInput	Interface
UpdateWebACLCommandOutput	Interface
UpdateWebACLRequest	Interface
UpdateWebACLResponse	Interface
UpdateXssMatchSetCommand	Class
UpdateXssMatchSetCommandInput	Interface
UpdateXssMatchSetCommandOutput	Interface
UpdateXssMatchSetRequest	Interface
UpdateXssMatchSetResponse	Interface
WAF	Class
WAF	Interface
WafAction	Interface
WafActionType	TypeAlias
WafActionTypeenum	Variable
WAFBadRequestException	Class
WAFClient	Class
WAFClientConfig	Interface
WAFClientConfigType	TypeAlias
WAFClientResolvedConfig	Interface
WAFClientResolvedConfigType	TypeAlias
WAFDisallowedNameException	Class
WAFEntityMigrationException	Class
WAFInternalErrorException	Class
WAFInvalidAccountException	Class
WAFInvalidOperationException	Class
WAFInvalidParameterException	Class
WAFInvalidPermissionPolicyException	Class
WAFInvalidRegexPatternException	Class
WAFLimitsExceededException	Class
WAFNonEmptyEntityException	Class
WAFNonexistentContainerException	Class
WAFNonexistentItemException	Class
WafOverrideAction	Interface
WafOverrideActionType	TypeAlias
WafOverrideActionTypeenum	Variable
WAFReferencedItemException	Class
WafRuleType	TypeAlias
WafRuleTypeenum	Variable
WAFServiceException	Class
WAFServiceLinkedRoleErrorException	Class
WAFStaleDataException	Class
WAFSubscriptionNotFoundException	Class
WAFTagOperationException	Class
WAFTagOperationInternalErrorException	Class
WebACL	Interface
WebACLSummary	Interface
WebACLUpdate	Interface
XssMatchSet	Interface
XssMatchSetSummary	Interface
XssMatchSetUpdate	Interface
XssMatchTuple	Interface

Getting Started

References

@aws-sdk/client-waf

Description

Installation

Types

Table of Contents

Search