WAF module
Index > WAF
Auto-generated documentation for WAF type annotations stubs module mypy-boto3-waf.
How to install
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 boto3-stubs
for WAF
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[waf]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[waf]'
# standalone installation
python -m pip install mypy-boto3-waf
How to uninstall
Usage
Code samples can be found in Examples.
WAFClient
Type annotations and code completion for boto3.client("waf")
as WAFClient
boto3 documentation
Usage example
from boto3.session import Session
from mypy_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("...")
.
Usage example
from boto3.session import Session
from mypy_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 schemas.
Usage example
from mypy_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
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_waf.type_defs import ExcludedRuleTypeDef
def get_value() -> ExcludedRuleTypeDef:
return {
"RuleId": ...,
}
- ExcludedRuleTypeDef
- WafActionTypeDef
- WafOverrideActionTypeDef
- ByteMatchSetSummaryTypeDef
- FieldToMatchTypeDef
- CreateByteMatchSetRequestRequestTypeDef
- ResponseMetadataTypeDef
- CreateGeoMatchSetRequestRequestTypeDef
- CreateIPSetRequestRequestTypeDef
- TagTypeDef
- CreateRegexMatchSetRequestRequestTypeDef
- CreateRegexPatternSetRequestRequestTypeDef
- RegexPatternSetTypeDef
- RuleGroupTypeDef
- CreateSizeConstraintSetRequestRequestTypeDef
- CreateSqlInjectionMatchSetRequestRequestTypeDef
- CreateWebACLMigrationStackRequestRequestTypeDef
- CreateXssMatchSetRequestRequestTypeDef
- DeleteByteMatchSetRequestRequestTypeDef
- DeleteGeoMatchSetRequestRequestTypeDef
- DeleteIPSetRequestRequestTypeDef
- DeleteLoggingConfigurationRequestRequestTypeDef
- DeletePermissionPolicyRequestRequestTypeDef
- DeleteRateBasedRuleRequestRequestTypeDef
- DeleteRegexMatchSetRequestRequestTypeDef
- DeleteRegexPatternSetRequestRequestTypeDef
- DeleteRuleGroupRequestRequestTypeDef
- DeleteRuleRequestRequestTypeDef
- DeleteSizeConstraintSetRequestRequestTypeDef
- DeleteSqlInjectionMatchSetRequestRequestTypeDef
- DeleteWebACLRequestRequestTypeDef
- DeleteXssMatchSetRequestRequestTypeDef
- GeoMatchConstraintTypeDef
- GeoMatchSetSummaryTypeDef
- GetByteMatchSetRequestRequestTypeDef
- GetChangeTokenStatusRequestRequestTypeDef
- GetGeoMatchSetRequestRequestTypeDef
- GetIPSetRequestRequestTypeDef
- GetLoggingConfigurationRequestRequestTypeDef
- GetPermissionPolicyRequestRequestTypeDef
- PaginatorConfigTypeDef
- GetRateBasedRuleManagedKeysRequestRequestTypeDef
- GetRateBasedRuleRequestRequestTypeDef
- GetRegexMatchSetRequestRequestTypeDef
- GetRegexPatternSetRequestRequestTypeDef
- GetRuleGroupRequestRequestTypeDef
- GetRuleRequestRequestTypeDef
- TimeWindowTypeDef
- GetSizeConstraintSetRequestRequestTypeDef
- GetSqlInjectionMatchSetRequestRequestTypeDef
- GetWebACLRequestRequestTypeDef
- GetXssMatchSetRequestRequestTypeDef
- HTTPHeaderTypeDef
- IPSetDescriptorTypeDef
- IPSetSummaryTypeDef
- ListActivatedRulesInRuleGroupRequestRequestTypeDef
- ListByteMatchSetsRequestRequestTypeDef
- ListGeoMatchSetsRequestRequestTypeDef
- ListIPSetsRequestRequestTypeDef
- ListLoggingConfigurationsRequestRequestTypeDef
- ListRateBasedRulesRequestRequestTypeDef
- RuleSummaryTypeDef
- ListRegexMatchSetsRequestRequestTypeDef
- RegexMatchSetSummaryTypeDef
- ListRegexPatternSetsRequestRequestTypeDef
- RegexPatternSetSummaryTypeDef
- ListRuleGroupsRequestRequestTypeDef
- RuleGroupSummaryTypeDef
- ListRulesRequestRequestTypeDef
- ListSizeConstraintSetsRequestRequestTypeDef
- SizeConstraintSetSummaryTypeDef
- ListSqlInjectionMatchSetsRequestRequestTypeDef
- SqlInjectionMatchSetSummaryTypeDef
- ListSubscribedRuleGroupsRequestRequestTypeDef
- SubscribedRuleGroupSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListWebACLsRequestRequestTypeDef
- WebACLSummaryTypeDef
- ListXssMatchSetsRequestRequestTypeDef
- XssMatchSetSummaryTypeDef
- PredicateTypeDef
- PutPermissionPolicyRequestRequestTypeDef
- RegexPatternSetUpdateTypeDef
- UntagResourceRequestRequestTypeDef
- ActivatedRuleTypeDef
- ByteMatchTupleTypeDef
- 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
- CreateRateBasedRuleRequestRequestTypeDef
- CreateRuleGroupRequestRequestTypeDef
- CreateRuleRequestRequestTypeDef
- CreateWebACLRequestRequestTypeDef
- TagInfoForResourceTypeDef
- TagResourceRequestRequestTypeDef
- CreateRegexPatternSetResponseTypeDef
- GetRegexPatternSetResponseTypeDef
- CreateRuleGroupResponseTypeDef
- GetRuleGroupResponseTypeDef
- GeoMatchSetTypeDef
- GeoMatchSetUpdateTypeDef
- ListGeoMatchSetsResponseTypeDef
- GetRateBasedRuleManagedKeysRequestGetRateBasedRuleManagedKeysPaginateTypeDef
- ListActivatedRulesInRuleGroupRequestListActivatedRulesInRuleGroupPaginateTypeDef
- ListByteMatchSetsRequestListByteMatchSetsPaginateTypeDef
- ListGeoMatchSetsRequestListGeoMatchSetsPaginateTypeDef
- ListIPSetsRequestListIPSetsPaginateTypeDef
- ListLoggingConfigurationsRequestListLoggingConfigurationsPaginateTypeDef
- ListRateBasedRulesRequestListRateBasedRulesPaginateTypeDef
- ListRegexMatchSetsRequestListRegexMatchSetsPaginateTypeDef
- ListRegexPatternSetsRequestListRegexPatternSetsPaginateTypeDef
- ListRuleGroupsRequestListRuleGroupsPaginateTypeDef
- ListRulesRequestListRulesPaginateTypeDef
- ListSizeConstraintSetsRequestListSizeConstraintSetsPaginateTypeDef
- ListSqlInjectionMatchSetsRequestListSqlInjectionMatchSetsPaginateTypeDef
- ListSubscribedRuleGroupsRequestListSubscribedRuleGroupsPaginateTypeDef
- ListWebACLsRequestListWebACLsPaginateTypeDef
- ListXssMatchSetsRequestListXssMatchSetsPaginateTypeDef
- GetSampledRequestsRequestRequestTypeDef
- HTTPRequestTypeDef
- IPSetTypeDef
- IPSetUpdateTypeDef
- ListIPSetsResponseTypeDef
- ListRateBasedRulesResponseTypeDef
- ListRulesResponseTypeDef
- ListRegexMatchSetsResponseTypeDef
- ListRegexPatternSetsResponseTypeDef
- ListRuleGroupsResponseTypeDef
- ListSizeConstraintSetsResponseTypeDef
- ListSqlInjectionMatchSetsResponseTypeDef
- ListSubscribedRuleGroupsResponseTypeDef
- ListWebACLsResponseTypeDef
- ListXssMatchSetsResponseTypeDef
- RateBasedRuleTypeDef
- RuleTypeDef
- RuleUpdateTypeDef
- UpdateRegexPatternSetRequestRequestTypeDef
- ListActivatedRulesInRuleGroupResponseTypeDef
- RuleGroupUpdateTypeDef
- WebACLTypeDef
- WebACLUpdateTypeDef
- ByteMatchSetTypeDef
- ByteMatchSetUpdateTypeDef
- GetLoggingConfigurationResponseTypeDef
- ListLoggingConfigurationsResponseTypeDef
- PutLoggingConfigurationRequestRequestTypeDef
- PutLoggingConfigurationResponseTypeDef
- RegexMatchSetTypeDef
- RegexMatchSetUpdateTypeDef
- SizeConstraintSetTypeDef
- SizeConstraintSetUpdateTypeDef
- SqlInjectionMatchSetTypeDef
- SqlInjectionMatchSetUpdateTypeDef
- XssMatchSetTypeDef
- XssMatchSetUpdateTypeDef
- ListTagsForResourceResponseTypeDef
- CreateGeoMatchSetResponseTypeDef
- GetGeoMatchSetResponseTypeDef
- UpdateGeoMatchSetRequestRequestTypeDef
- SampledHTTPRequestTypeDef
- CreateIPSetResponseTypeDef
- GetIPSetResponseTypeDef
- UpdateIPSetRequestRequestTypeDef
- CreateRateBasedRuleResponseTypeDef
- GetRateBasedRuleResponseTypeDef
- CreateRuleResponseTypeDef
- GetRuleResponseTypeDef
- UpdateRateBasedRuleRequestRequestTypeDef
- UpdateRuleRequestRequestTypeDef
- UpdateRuleGroupRequestRequestTypeDef
- CreateWebACLResponseTypeDef
- GetWebACLResponseTypeDef
- UpdateWebACLRequestRequestTypeDef
- CreateByteMatchSetResponseTypeDef
- GetByteMatchSetResponseTypeDef
- UpdateByteMatchSetRequestRequestTypeDef
- CreateRegexMatchSetResponseTypeDef
- GetRegexMatchSetResponseTypeDef
- UpdateRegexMatchSetRequestRequestTypeDef
- CreateSizeConstraintSetResponseTypeDef
- GetSizeConstraintSetResponseTypeDef
- UpdateSizeConstraintSetRequestRequestTypeDef
- CreateSqlInjectionMatchSetResponseTypeDef
- GetSqlInjectionMatchSetResponseTypeDef
- UpdateSqlInjectionMatchSetRequestRequestTypeDef
- CreateXssMatchSetResponseTypeDef
- GetXssMatchSetResponseTypeDef
- UpdateXssMatchSetRequestRequestTypeDef
- GetSampledRequestsResponseTypeDef