WAF module#
Index > WAF
Auto-generated documentation for WAF type annotations stubs module types-boto3-waf.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
WAF
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and WAF
.
From PyPI with pip#
Install types-boto3
for WAF
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[waf]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[waf]'
# standalone installation
python -m pip install types-boto3-waf
How to uninstall#
python -m pip uninstall -y types-boto3-waf
Usage#
Code samples can be found in Examples.
WAFClient#
Type annotations and code completion for boto3.client("waf")
as WAFClient
boto3 documentation
# WAFClient usage example
from boto3.session import Session
from types_boto3_waf.client import WAFClient
def get_client() -> WAFClient:
return Session().client("waf")
Paginators#
Type annotations and code completion for paginators
from boto3.client("waf").get_paginator("...")
.
# GetRateBasedRuleManagedKeysPaginator usage example
from boto3.session import Session
from types_boto3_waf.paginator import GetRateBasedRuleManagedKeysPaginator
def get_get_rate_based_rule_managed_keys_paginator() -> GetRateBasedRuleManagedKeysPaginator:
return Session().client("waf").get_paginator("get_rate_based_rule_managed_keys"))
- GetRateBasedRuleManagedKeysPaginator
- ListActivatedRulesInRuleGroupPaginator
- ListByteMatchSetsPaginator
- ListGeoMatchSetsPaginator
- ListIPSetsPaginator
- ListLoggingConfigurationsPaginator
- ListRateBasedRulesPaginator
- ListRegexMatchSetsPaginator
- ListRegexPatternSetsPaginator
- ListRuleGroupsPaginator
- ListRulesPaginator
- ListSizeConstraintSetsPaginator
- ListSqlInjectionMatchSetsPaginator
- ListSubscribedRuleGroupsPaginator
- ListWebACLsPaginator
- ListXssMatchSetsPaginator
Literals#
Type annotations for literals used in methods and schema.
# ChangeActionType usage example
from types_boto3_waf.literals import ChangeActionType
def get_value() -> ChangeActionType:
return "DELETE"
- ChangeActionType
- ChangeTokenStatusType
- ComparisonOperatorType
- GeoMatchConstraintTypeType
- GeoMatchConstraintValueType
- GetRateBasedRuleManagedKeysPaginatorName
- IPSetDescriptorTypeType
- ListActivatedRulesInRuleGroupPaginatorName
- ListByteMatchSetsPaginatorName
- ListGeoMatchSetsPaginatorName
- ListIPSetsPaginatorName
- ListLoggingConfigurationsPaginatorName
- ListRateBasedRulesPaginatorName
- ListRegexMatchSetsPaginatorName
- ListRegexPatternSetsPaginatorName
- ListRuleGroupsPaginatorName
- ListRulesPaginatorName
- ListSizeConstraintSetsPaginatorName
- ListSqlInjectionMatchSetsPaginatorName
- ListSubscribedRuleGroupsPaginatorName
- ListWebACLsPaginatorName
- ListXssMatchSetsPaginatorName
- MatchFieldTypeType
- PositionalConstraintType
- PredicateTypeType
- RateKeyType
- TextTransformationType
- WafActionTypeType
- WafOverrideActionTypeType
- WafRuleTypeType
- WAFServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ExcludedRuleTypeDef
- WafActionTypeDef
- WafOverrideActionTypeDef
- BlobTypeDef
- ByteMatchSetSummaryTypeDef
- FieldToMatchTypeDef
- CreateByteMatchSetRequestTypeDef
- ResponseMetadataTypeDef
- CreateGeoMatchSetRequestTypeDef
- CreateIPSetRequestTypeDef
- TagTypeDef
- CreateRegexMatchSetRequestTypeDef
- CreateRegexPatternSetRequestTypeDef
- RegexPatternSetTypeDef
- RuleGroupTypeDef
- CreateSizeConstraintSetRequestTypeDef
- CreateSqlInjectionMatchSetRequestTypeDef
- CreateWebACLMigrationStackRequestTypeDef
- CreateXssMatchSetRequestTypeDef
- DeleteByteMatchSetRequestTypeDef
- DeleteGeoMatchSetRequestTypeDef
- DeleteIPSetRequestTypeDef
- DeleteLoggingConfigurationRequestTypeDef
- DeletePermissionPolicyRequestTypeDef
- DeleteRateBasedRuleRequestTypeDef
- DeleteRegexMatchSetRequestTypeDef
- DeleteRegexPatternSetRequestTypeDef
- DeleteRuleGroupRequestTypeDef
- DeleteRuleRequestTypeDef
- DeleteSizeConstraintSetRequestTypeDef
- DeleteSqlInjectionMatchSetRequestTypeDef
- DeleteWebACLRequestTypeDef
- DeleteXssMatchSetRequestTypeDef
- GeoMatchConstraintTypeDef
- GeoMatchSetSummaryTypeDef
- GetByteMatchSetRequestTypeDef
- GetChangeTokenStatusRequestTypeDef
- GetGeoMatchSetRequestTypeDef
- GetIPSetRequestTypeDef
- GetLoggingConfigurationRequestTypeDef
- GetPermissionPolicyRequestTypeDef
- PaginatorConfigTypeDef
- GetRateBasedRuleManagedKeysRequestTypeDef
- GetRateBasedRuleRequestTypeDef
- GetRegexMatchSetRequestTypeDef
- GetRegexPatternSetRequestTypeDef
- GetRuleGroupRequestTypeDef
- GetRuleRequestTypeDef
- TimeWindowOutputTypeDef
- GetSizeConstraintSetRequestTypeDef
- GetSqlInjectionMatchSetRequestTypeDef
- GetWebACLRequestTypeDef
- GetXssMatchSetRequestTypeDef
- HTTPHeaderTypeDef
- IPSetDescriptorTypeDef
- IPSetSummaryTypeDef
- ListActivatedRulesInRuleGroupRequestTypeDef
- ListByteMatchSetsRequestTypeDef
- ListGeoMatchSetsRequestTypeDef
- ListIPSetsRequestTypeDef
- ListLoggingConfigurationsRequestTypeDef
- ListRateBasedRulesRequestTypeDef
- RuleSummaryTypeDef
- ListRegexMatchSetsRequestTypeDef
- RegexMatchSetSummaryTypeDef
- ListRegexPatternSetsRequestTypeDef
- RegexPatternSetSummaryTypeDef
- ListRuleGroupsRequestTypeDef
- RuleGroupSummaryTypeDef
- ListRulesRequestTypeDef
- ListSizeConstraintSetsRequestTypeDef
- SizeConstraintSetSummaryTypeDef
- ListSqlInjectionMatchSetsRequestTypeDef
- SqlInjectionMatchSetSummaryTypeDef
- ListSubscribedRuleGroupsRequestTypeDef
- SubscribedRuleGroupSummaryTypeDef
- ListTagsForResourceRequestTypeDef
- ListWebACLsRequestTypeDef
- WebACLSummaryTypeDef
- ListXssMatchSetsRequestTypeDef
- XssMatchSetSummaryTypeDef
- PredicateTypeDef
- PutPermissionPolicyRequestTypeDef
- RegexPatternSetUpdateTypeDef
- TimestampTypeDef
- UntagResourceRequestTypeDef
- ActivatedRuleOutputTypeDef
- ActivatedRuleTypeDef
- ByteMatchTupleOutputTypeDef
- ByteMatchTupleTypeDef
- LoggingConfigurationOutputTypeDef
- LoggingConfigurationTypeDef
- RegexMatchTupleTypeDef
- SizeConstraintTypeDef
- SqlInjectionMatchTupleTypeDef
- XssMatchTupleTypeDef
- CreateWebACLMigrationStackResponseTypeDef
- DeleteByteMatchSetResponseTypeDef
- DeleteGeoMatchSetResponseTypeDef
- DeleteIPSetResponseTypeDef
- DeleteRateBasedRuleResponseTypeDef
- DeleteRegexMatchSetResponseTypeDef
- DeleteRegexPatternSetResponseTypeDef
- DeleteRuleGroupResponseTypeDef
- DeleteRuleResponseTypeDef
- DeleteSizeConstraintSetResponseTypeDef
- DeleteSqlInjectionMatchSetResponseTypeDef
- DeleteWebACLResponseTypeDef
- DeleteXssMatchSetResponseTypeDef
- GetChangeTokenResponseTypeDef
- GetChangeTokenStatusResponseTypeDef
- GetPermissionPolicyResponseTypeDef
- GetRateBasedRuleManagedKeysResponseTypeDef
- ListByteMatchSetsResponseTypeDef
- UpdateByteMatchSetResponseTypeDef
- UpdateGeoMatchSetResponseTypeDef
- UpdateIPSetResponseTypeDef
- UpdateRateBasedRuleResponseTypeDef
- UpdateRegexMatchSetResponseTypeDef
- UpdateRegexPatternSetResponseTypeDef
- UpdateRuleGroupResponseTypeDef
- UpdateRuleResponseTypeDef
- UpdateSizeConstraintSetResponseTypeDef
- UpdateSqlInjectionMatchSetResponseTypeDef
- UpdateWebACLResponseTypeDef
- UpdateXssMatchSetResponseTypeDef
- CreateRateBasedRuleRequestTypeDef
- CreateRuleGroupRequestTypeDef
- CreateRuleRequestTypeDef
- CreateWebACLRequestTypeDef
- TagInfoForResourceTypeDef
- TagResourceRequestTypeDef
- CreateRegexPatternSetResponseTypeDef
- GetRegexPatternSetResponseTypeDef
- CreateRuleGroupResponseTypeDef
- GetRuleGroupResponseTypeDef
- GeoMatchSetTypeDef
- GeoMatchSetUpdateTypeDef
- ListGeoMatchSetsResponseTypeDef
- GetRateBasedRuleManagedKeysRequestPaginateTypeDef
- ListActivatedRulesInRuleGroupRequestPaginateTypeDef
- ListByteMatchSetsRequestPaginateTypeDef
- ListGeoMatchSetsRequestPaginateTypeDef
- ListIPSetsRequestPaginateTypeDef
- ListLoggingConfigurationsRequestPaginateTypeDef
- ListRateBasedRulesRequestPaginateTypeDef
- ListRegexMatchSetsRequestPaginateTypeDef
- ListRegexPatternSetsRequestPaginateTypeDef
- ListRuleGroupsRequestPaginateTypeDef
- ListRulesRequestPaginateTypeDef
- ListSizeConstraintSetsRequestPaginateTypeDef
- ListSqlInjectionMatchSetsRequestPaginateTypeDef
- ListSubscribedRuleGroupsRequestPaginateTypeDef
- ListWebACLsRequestPaginateTypeDef
- ListXssMatchSetsRequestPaginateTypeDef
- HTTPRequestTypeDef
- IPSetTypeDef
- IPSetUpdateTypeDef
- ListIPSetsResponseTypeDef
- ListRateBasedRulesResponseTypeDef
- ListRulesResponseTypeDef
- ListRegexMatchSetsResponseTypeDef
- ListRegexPatternSetsResponseTypeDef
- ListRuleGroupsResponseTypeDef
- ListSizeConstraintSetsResponseTypeDef
- ListSqlInjectionMatchSetsResponseTypeDef
- ListSubscribedRuleGroupsResponseTypeDef
- ListWebACLsResponseTypeDef
- ListXssMatchSetsResponseTypeDef
- RateBasedRuleTypeDef
- RuleTypeDef
- RuleUpdateTypeDef
- UpdateRegexPatternSetRequestTypeDef
- TimeWindowTypeDef
- ListActivatedRulesInRuleGroupResponseTypeDef
- WebACLTypeDef
- ActivatedRuleUnionTypeDef
- ByteMatchSetTypeDef
- ByteMatchTupleUnionTypeDef
- GetLoggingConfigurationResponseTypeDef
- ListLoggingConfigurationsResponseTypeDef
- PutLoggingConfigurationResponseTypeDef
- LoggingConfigurationUnionTypeDef
- RegexMatchSetTypeDef
- RegexMatchSetUpdateTypeDef
- SizeConstraintSetTypeDef
- SizeConstraintSetUpdateTypeDef
- SqlInjectionMatchSetTypeDef
- SqlInjectionMatchSetUpdateTypeDef
- XssMatchSetTypeDef
- XssMatchSetUpdateTypeDef
- ListTagsForResourceResponseTypeDef
- CreateGeoMatchSetResponseTypeDef
- GetGeoMatchSetResponseTypeDef
- UpdateGeoMatchSetRequestTypeDef
- SampledHTTPRequestTypeDef
- CreateIPSetResponseTypeDef
- GetIPSetResponseTypeDef
- UpdateIPSetRequestTypeDef
- CreateRateBasedRuleResponseTypeDef
- GetRateBasedRuleResponseTypeDef
- CreateRuleResponseTypeDef
- GetRuleResponseTypeDef
- UpdateRateBasedRuleRequestTypeDef
- UpdateRuleRequestTypeDef
- TimeWindowUnionTypeDef
- CreateWebACLResponseTypeDef
- GetWebACLResponseTypeDef
- RuleGroupUpdateTypeDef
- WebACLUpdateTypeDef
- CreateByteMatchSetResponseTypeDef
- GetByteMatchSetResponseTypeDef
- ByteMatchSetUpdateTypeDef
- PutLoggingConfigurationRequestTypeDef
- CreateRegexMatchSetResponseTypeDef
- GetRegexMatchSetResponseTypeDef
- UpdateRegexMatchSetRequestTypeDef
- CreateSizeConstraintSetResponseTypeDef
- GetSizeConstraintSetResponseTypeDef
- UpdateSizeConstraintSetRequestTypeDef
- CreateSqlInjectionMatchSetResponseTypeDef
- GetSqlInjectionMatchSetResponseTypeDef
- UpdateSqlInjectionMatchSetRequestTypeDef
- CreateXssMatchSetResponseTypeDef
- GetXssMatchSetResponseTypeDef
- UpdateXssMatchSetRequestTypeDef
- GetSampledRequestsResponseTypeDef
- GetSampledRequestsRequestTypeDef
- UpdateRuleGroupRequestTypeDef
- UpdateWebACLRequestTypeDef
- UpdateByteMatchSetRequestTypeDef