Type definitions#
Auto-generated documentation for WAFV2 type annotations stubs module types-boto3-wafv2.
BlobTypeDef#
# BlobTypeDef Union usage example
from types_boto3_wafv2.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]TimestampTypeDef#
# TimestampTypeDef Union usage example
from types_boto3_wafv2.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]AndStatementUnionTypeDef#
# AndStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import AndStatementUnionTypeDef
def get_value() -> AndStatementUnionTypeDef:
return ...
# AndStatementUnionTypeDef definition
AndStatementUnionTypeDef = Union[
AndStatementTypeDef, # (1)
AndStatementOutputTypeDef, # (2)
]CookieMatchPatternUnionTypeDef#
# CookieMatchPatternUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import CookieMatchPatternUnionTypeDef
def get_value() -> CookieMatchPatternUnionTypeDef:
return ...
# CookieMatchPatternUnionTypeDef definition
CookieMatchPatternUnionTypeDef = Union[
CookieMatchPatternTypeDef, # (1)
CookieMatchPatternOutputTypeDef, # (2)
]HeaderMatchPatternUnionTypeDef#
# HeaderMatchPatternUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import HeaderMatchPatternUnionTypeDef
def get_value() -> HeaderMatchPatternUnionTypeDef:
return ...
# HeaderMatchPatternUnionTypeDef definition
HeaderMatchPatternUnionTypeDef = Union[
HeaderMatchPatternTypeDef, # (1)
HeaderMatchPatternOutputTypeDef, # (2)
]JsonMatchPatternUnionTypeDef#
# JsonMatchPatternUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import JsonMatchPatternUnionTypeDef
def get_value() -> JsonMatchPatternUnionTypeDef:
return ...
# JsonMatchPatternUnionTypeDef definition
JsonMatchPatternUnionTypeDef = Union[
JsonMatchPatternTypeDef, # (1)
JsonMatchPatternOutputTypeDef, # (2)
]NotStatementUnionTypeDef#
# NotStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import NotStatementUnionTypeDef
def get_value() -> NotStatementUnionTypeDef:
return ...
# NotStatementUnionTypeDef definition
NotStatementUnionTypeDef = Union[
NotStatementTypeDef, # (1)
NotStatementOutputTypeDef, # (2)
]OrStatementUnionTypeDef#
# OrStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import OrStatementUnionTypeDef
def get_value() -> OrStatementUnionTypeDef:
return ...
# OrStatementUnionTypeDef definition
OrStatementUnionTypeDef = Union[
OrStatementTypeDef, # (1)
OrStatementOutputTypeDef, # (2)
]ResponseInspectionBodyContainsUnionTypeDef#
# ResponseInspectionBodyContainsUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import ResponseInspectionBodyContainsUnionTypeDef
def get_value() -> ResponseInspectionBodyContainsUnionTypeDef:
return ...
# ResponseInspectionBodyContainsUnionTypeDef definition
ResponseInspectionBodyContainsUnionTypeDef = Union[
ResponseInspectionBodyContainsTypeDef, # (1)
ResponseInspectionBodyContainsOutputTypeDef, # (2)
]ResponseInspectionHeaderUnionTypeDef#
# ResponseInspectionHeaderUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import ResponseInspectionHeaderUnionTypeDef
def get_value() -> ResponseInspectionHeaderUnionTypeDef:
return ...
# ResponseInspectionHeaderUnionTypeDef definition
ResponseInspectionHeaderUnionTypeDef = Union[
ResponseInspectionHeaderTypeDef, # (1)
ResponseInspectionHeaderOutputTypeDef, # (2)
]ResponseInspectionJsonUnionTypeDef#
# ResponseInspectionJsonUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import ResponseInspectionJsonUnionTypeDef
def get_value() -> ResponseInspectionJsonUnionTypeDef:
return ...
# ResponseInspectionJsonUnionTypeDef definition
ResponseInspectionJsonUnionTypeDef = Union[
ResponseInspectionJsonTypeDef, # (1)
ResponseInspectionJsonOutputTypeDef, # (2)
]ResponseInspectionStatusCodeUnionTypeDef#
# ResponseInspectionStatusCodeUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import ResponseInspectionStatusCodeUnionTypeDef
def get_value() -> ResponseInspectionStatusCodeUnionTypeDef:
return ...
# ResponseInspectionStatusCodeUnionTypeDef definition
ResponseInspectionStatusCodeUnionTypeDef = Union[
ResponseInspectionStatusCodeTypeDef, # (1)
ResponseInspectionStatusCodeOutputTypeDef, # (2)
]AssociationConfigUnionTypeDef#
# AssociationConfigUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import AssociationConfigUnionTypeDef
def get_value() -> AssociationConfigUnionTypeDef:
return ...
# AssociationConfigUnionTypeDef definition
AssociationConfigUnionTypeDef = Union[
AssociationConfigTypeDef, # (1)
AssociationConfigOutputTypeDef, # (2)
]RateLimitCookieUnionTypeDef#
# RateLimitCookieUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RateLimitCookieUnionTypeDef
def get_value() -> RateLimitCookieUnionTypeDef:
return ...
# RateLimitCookieUnionTypeDef definition
RateLimitCookieUnionTypeDef = Union[
RateLimitCookieTypeDef, # (1)
RateLimitCookieOutputTypeDef, # (2)
]RateLimitHeaderUnionTypeDef#
# RateLimitHeaderUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RateLimitHeaderUnionTypeDef
def get_value() -> RateLimitHeaderUnionTypeDef:
return ...
# RateLimitHeaderUnionTypeDef definition
RateLimitHeaderUnionTypeDef = Union[
RateLimitHeaderTypeDef, # (1)
RateLimitHeaderOutputTypeDef, # (2)
]RateLimitQueryArgumentUnionTypeDef#
# RateLimitQueryArgumentUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RateLimitQueryArgumentUnionTypeDef
def get_value() -> RateLimitQueryArgumentUnionTypeDef:
return ...
# RateLimitQueryArgumentUnionTypeDef definition
RateLimitQueryArgumentUnionTypeDef = Union[
RateLimitQueryArgumentTypeDef, # (1)
RateLimitQueryArgumentOutputTypeDef, # (2)
]RateLimitQueryStringUnionTypeDef#
# RateLimitQueryStringUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RateLimitQueryStringUnionTypeDef
def get_value() -> RateLimitQueryStringUnionTypeDef:
return ...
# RateLimitQueryStringUnionTypeDef definition
RateLimitQueryStringUnionTypeDef = Union[
RateLimitQueryStringTypeDef, # (1)
RateLimitQueryStringOutputTypeDef, # (2)
]RateLimitUriPathUnionTypeDef#
# RateLimitUriPathUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RateLimitUriPathUnionTypeDef
def get_value() -> RateLimitUriPathUnionTypeDef:
return ...
# RateLimitUriPathUnionTypeDef definition
RateLimitUriPathUnionTypeDef = Union[
RateLimitUriPathTypeDef, # (1)
RateLimitUriPathOutputTypeDef, # (2)
]CustomRequestHandlingUnionTypeDef#
# CustomRequestHandlingUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import CustomRequestHandlingUnionTypeDef
def get_value() -> CustomRequestHandlingUnionTypeDef:
return ...
# CustomRequestHandlingUnionTypeDef definition
CustomRequestHandlingUnionTypeDef = Union[
CustomRequestHandlingTypeDef, # (1)
CustomRequestHandlingOutputTypeDef, # (2)
]CustomResponseUnionTypeDef#
# CustomResponseUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import CustomResponseUnionTypeDef
def get_value() -> CustomResponseUnionTypeDef:
return ...
# CustomResponseUnionTypeDef definition
CustomResponseUnionTypeDef = Union[
CustomResponseTypeDef, # (1)
CustomResponseOutputTypeDef, # (2)
]GeoMatchStatementUnionTypeDef#
# GeoMatchStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import GeoMatchStatementUnionTypeDef
def get_value() -> GeoMatchStatementUnionTypeDef:
return ...
# GeoMatchStatementUnionTypeDef definition
GeoMatchStatementUnionTypeDef = Union[
GeoMatchStatementTypeDef, # (1)
GeoMatchStatementOutputTypeDef, # (2)
]RequestInspectionACFPUnionTypeDef#
# RequestInspectionACFPUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RequestInspectionACFPUnionTypeDef
def get_value() -> RequestInspectionACFPUnionTypeDef:
return ...
# RequestInspectionACFPUnionTypeDef definition
RequestInspectionACFPUnionTypeDef = Union[
RequestInspectionACFPTypeDef, # (1)
RequestInspectionACFPOutputTypeDef, # (2)
]TimeWindowUnionTypeDef#
# TimeWindowUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import TimeWindowUnionTypeDef
def get_value() -> TimeWindowUnionTypeDef:
return ...
# TimeWindowUnionTypeDef definition
TimeWindowUnionTypeDef = Union[
TimeWindowTypeDef, # (1)
TimeWindowOutputTypeDef, # (2)
]CookiesUnionTypeDef#
# CookiesUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import CookiesUnionTypeDef
def get_value() -> CookiesUnionTypeDef:
return ...
# CookiesUnionTypeDef definition
CookiesUnionTypeDef = Union[
CookiesTypeDef, # (1)
CookiesOutputTypeDef, # (2)
]- See CookiesTypeDef
- See CookiesOutputTypeDef
DataProtectionConfigUnionTypeDef#
# DataProtectionConfigUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import DataProtectionConfigUnionTypeDef
def get_value() -> DataProtectionConfigUnionTypeDef:
return ...
# DataProtectionConfigUnionTypeDef definition
DataProtectionConfigUnionTypeDef = Union[
DataProtectionConfigTypeDef, # (1)
DataProtectionConfigOutputTypeDef, # (2)
]HeadersUnionTypeDef#
# HeadersUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import HeadersUnionTypeDef
def get_value() -> HeadersUnionTypeDef:
return ...
# HeadersUnionTypeDef definition
HeadersUnionTypeDef = Union[
HeadersTypeDef, # (1)
HeadersOutputTypeDef, # (2)
]- See HeadersTypeDef
- See HeadersOutputTypeDef
JsonBodyUnionTypeDef#
# JsonBodyUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import JsonBodyUnionTypeDef
def get_value() -> JsonBodyUnionTypeDef:
return ...
# JsonBodyUnionTypeDef definition
JsonBodyUnionTypeDef = Union[
JsonBodyTypeDef, # (1)
JsonBodyOutputTypeDef, # (2)
]- See JsonBodyTypeDef
- See JsonBodyOutputTypeDef
ResponseInspectionUnionTypeDef#
# ResponseInspectionUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import ResponseInspectionUnionTypeDef
def get_value() -> ResponseInspectionUnionTypeDef:
return ...
# ResponseInspectionUnionTypeDef definition
ResponseInspectionUnionTypeDef = Union[
ResponseInspectionTypeDef, # (1)
ResponseInspectionOutputTypeDef, # (2)
]RateBasedStatementCustomKeyUnionTypeDef#
# RateBasedStatementCustomKeyUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RateBasedStatementCustomKeyUnionTypeDef
def get_value() -> RateBasedStatementCustomKeyUnionTypeDef:
return ...
# RateBasedStatementCustomKeyUnionTypeDef definition
RateBasedStatementCustomKeyUnionTypeDef = Union[
RateBasedStatementCustomKeyTypeDef, # (1)
RateBasedStatementCustomKeyOutputTypeDef, # (2)
]AllowActionUnionTypeDef#
# AllowActionUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import AllowActionUnionTypeDef
def get_value() -> AllowActionUnionTypeDef:
return ...
# AllowActionUnionTypeDef definition
AllowActionUnionTypeDef = Union[
AllowActionTypeDef, # (1)
AllowActionOutputTypeDef, # (2)
]CaptchaActionUnionTypeDef#
# CaptchaActionUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import CaptchaActionUnionTypeDef
def get_value() -> CaptchaActionUnionTypeDef:
return ...
# CaptchaActionUnionTypeDef definition
CaptchaActionUnionTypeDef = Union[
CaptchaActionTypeDef, # (1)
CaptchaActionOutputTypeDef, # (2)
]ChallengeActionUnionTypeDef#
# ChallengeActionUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import ChallengeActionUnionTypeDef
def get_value() -> ChallengeActionUnionTypeDef:
return ...
# ChallengeActionUnionTypeDef definition
ChallengeActionUnionTypeDef = Union[
ChallengeActionTypeDef, # (1)
ChallengeActionOutputTypeDef, # (2)
]CountActionUnionTypeDef#
# CountActionUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import CountActionUnionTypeDef
def get_value() -> CountActionUnionTypeDef:
return ...
# CountActionUnionTypeDef definition
CountActionUnionTypeDef = Union[
CountActionTypeDef, # (1)
CountActionOutputTypeDef, # (2)
]BlockActionUnionTypeDef#
# BlockActionUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import BlockActionUnionTypeDef
def get_value() -> BlockActionUnionTypeDef:
return ...
# BlockActionUnionTypeDef definition
BlockActionUnionTypeDef = Union[
BlockActionTypeDef, # (1)
BlockActionOutputTypeDef, # (2)
]DefaultActionUnionTypeDef#
# DefaultActionUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import DefaultActionUnionTypeDef
def get_value() -> DefaultActionUnionTypeDef:
return ...
# DefaultActionUnionTypeDef definition
DefaultActionUnionTypeDef = Union[
DefaultActionTypeDef, # (1)
DefaultActionOutputTypeDef, # (2)
]FieldToMatchUnionTypeDef#
# FieldToMatchUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import FieldToMatchUnionTypeDef
def get_value() -> FieldToMatchUnionTypeDef:
return ...
# FieldToMatchUnionTypeDef definition
FieldToMatchUnionTypeDef = Union[
FieldToMatchTypeDef, # (1)
FieldToMatchOutputTypeDef, # (2)
]AWSManagedRulesACFPRuleSetUnionTypeDef#
# AWSManagedRulesACFPRuleSetUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import AWSManagedRulesACFPRuleSetUnionTypeDef
def get_value() -> AWSManagedRulesACFPRuleSetUnionTypeDef:
return ...
# AWSManagedRulesACFPRuleSetUnionTypeDef definition
AWSManagedRulesACFPRuleSetUnionTypeDef = Union[
AWSManagedRulesACFPRuleSetTypeDef, # (1)
AWSManagedRulesACFPRuleSetOutputTypeDef, # (2)
]AWSManagedRulesATPRuleSetUnionTypeDef#
# AWSManagedRulesATPRuleSetUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import AWSManagedRulesATPRuleSetUnionTypeDef
def get_value() -> AWSManagedRulesATPRuleSetUnionTypeDef:
return ...
# AWSManagedRulesATPRuleSetUnionTypeDef definition
AWSManagedRulesATPRuleSetUnionTypeDef = Union[
AWSManagedRulesATPRuleSetTypeDef, # (1)
AWSManagedRulesATPRuleSetOutputTypeDef, # (2)
]RateBasedStatementUnionTypeDef#
# RateBasedStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RateBasedStatementUnionTypeDef
def get_value() -> RateBasedStatementUnionTypeDef:
return ...
# RateBasedStatementUnionTypeDef definition
RateBasedStatementUnionTypeDef = Union[
RateBasedStatementTypeDef, # (1)
RateBasedStatementOutputTypeDef, # (2)
]OverrideActionUnionTypeDef#
# OverrideActionUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import OverrideActionUnionTypeDef
def get_value() -> OverrideActionUnionTypeDef:
return ...
# OverrideActionUnionTypeDef definition
OverrideActionUnionTypeDef = Union[
OverrideActionTypeDef, # (1)
OverrideActionOutputTypeDef, # (2)
]RuleActionUnionTypeDef#
# RuleActionUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RuleActionUnionTypeDef
def get_value() -> RuleActionUnionTypeDef:
return ...
# RuleActionUnionTypeDef definition
RuleActionUnionTypeDef = Union[
RuleActionTypeDef, # (1)
RuleActionOutputTypeDef, # (2)
]LoggingConfigurationUnionTypeDef#
# LoggingConfigurationUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import LoggingConfigurationUnionTypeDef
def get_value() -> LoggingConfigurationUnionTypeDef:
return ...
# LoggingConfigurationUnionTypeDef definition
LoggingConfigurationUnionTypeDef = Union[
LoggingConfigurationTypeDef, # (1)
LoggingConfigurationOutputTypeDef, # (2)
]ByteMatchStatementUnionTypeDef#
# ByteMatchStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import ByteMatchStatementUnionTypeDef
def get_value() -> ByteMatchStatementUnionTypeDef:
return ...
# ByteMatchStatementUnionTypeDef definition
ByteMatchStatementUnionTypeDef = Union[
ByteMatchStatementTypeDef, # (1)
ByteMatchStatementOutputTypeDef, # (2)
]RegexMatchStatementUnionTypeDef#
# RegexMatchStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RegexMatchStatementUnionTypeDef
def get_value() -> RegexMatchStatementUnionTypeDef:
return ...
# RegexMatchStatementUnionTypeDef definition
RegexMatchStatementUnionTypeDef = Union[
RegexMatchStatementTypeDef, # (1)
RegexMatchStatementOutputTypeDef, # (2)
]RegexPatternSetReferenceStatementUnionTypeDef#
# RegexPatternSetReferenceStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RegexPatternSetReferenceStatementUnionTypeDef
def get_value() -> RegexPatternSetReferenceStatementUnionTypeDef:
return ...
# RegexPatternSetReferenceStatementUnionTypeDef definition
RegexPatternSetReferenceStatementUnionTypeDef = Union[
RegexPatternSetReferenceStatementTypeDef, # (1)
RegexPatternSetReferenceStatementOutputTypeDef, # (2)
]SizeConstraintStatementUnionTypeDef#
# SizeConstraintStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import SizeConstraintStatementUnionTypeDef
def get_value() -> SizeConstraintStatementUnionTypeDef:
return ...
# SizeConstraintStatementUnionTypeDef definition
SizeConstraintStatementUnionTypeDef = Union[
SizeConstraintStatementTypeDef, # (1)
SizeConstraintStatementOutputTypeDef, # (2)
]SqliMatchStatementUnionTypeDef#
# SqliMatchStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import SqliMatchStatementUnionTypeDef
def get_value() -> SqliMatchStatementUnionTypeDef:
return ...
# SqliMatchStatementUnionTypeDef definition
SqliMatchStatementUnionTypeDef = Union[
SqliMatchStatementTypeDef, # (1)
SqliMatchStatementOutputTypeDef, # (2)
]XssMatchStatementUnionTypeDef#
# XssMatchStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import XssMatchStatementUnionTypeDef
def get_value() -> XssMatchStatementUnionTypeDef:
return ...
# XssMatchStatementUnionTypeDef definition
XssMatchStatementUnionTypeDef = Union[
XssMatchStatementTypeDef, # (1)
XssMatchStatementOutputTypeDef, # (2)
]ManagedRuleGroupConfigUnionTypeDef#
# ManagedRuleGroupConfigUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import ManagedRuleGroupConfigUnionTypeDef
def get_value() -> ManagedRuleGroupConfigUnionTypeDef:
return ...
# ManagedRuleGroupConfigUnionTypeDef definition
ManagedRuleGroupConfigUnionTypeDef = Union[
ManagedRuleGroupConfigTypeDef, # (1)
ManagedRuleGroupConfigOutputTypeDef, # (2)
]RuleActionOverrideUnionTypeDef#
# RuleActionOverrideUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RuleActionOverrideUnionTypeDef
def get_value() -> RuleActionOverrideUnionTypeDef:
return ...
# RuleActionOverrideUnionTypeDef definition
RuleActionOverrideUnionTypeDef = Union[
RuleActionOverrideTypeDef, # (1)
RuleActionOverrideOutputTypeDef, # (2)
]ManagedRuleGroupStatementUnionTypeDef#
# ManagedRuleGroupStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import ManagedRuleGroupStatementUnionTypeDef
def get_value() -> ManagedRuleGroupStatementUnionTypeDef:
return ...
# ManagedRuleGroupStatementUnionTypeDef definition
ManagedRuleGroupStatementUnionTypeDef = Union[
ManagedRuleGroupStatementTypeDef, # (1)
ManagedRuleGroupStatementOutputTypeDef, # (2)
]RuleGroupReferenceStatementUnionTypeDef#
# RuleGroupReferenceStatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RuleGroupReferenceStatementUnionTypeDef
def get_value() -> RuleGroupReferenceStatementUnionTypeDef:
return ...
# RuleGroupReferenceStatementUnionTypeDef definition
RuleGroupReferenceStatementUnionTypeDef = Union[
RuleGroupReferenceStatementTypeDef, # (1)
RuleGroupReferenceStatementOutputTypeDef, # (2)
]StatementUnionTypeDef#
# StatementUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import StatementUnionTypeDef
def get_value() -> StatementUnionTypeDef:
return ...
# StatementUnionTypeDef definition
StatementUnionTypeDef = Union[
StatementTypeDef, # (1)
StatementOutputTypeDef, # (2)
]RuleUnionTypeDef#
# RuleUnionTypeDef Union usage example
from types_boto3_wafv2.type_defs import RuleUnionTypeDef
def get_value() -> RuleUnionTypeDef:
return ...
# RuleUnionTypeDef definition
RuleUnionTypeDef = Union[
RuleTypeDef, # (1)
RuleOutputTypeDef, # (2)
]- See RuleTypeDef
- See RuleOutputTypeDef
APIKeySummaryTypeDef#
# APIKeySummaryTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import APIKeySummaryTypeDef
def get_value() -> APIKeySummaryTypeDef:
return {
"TokenDomains": ...,
}
# APIKeySummaryTypeDef definition
class APIKeySummaryTypeDef(TypedDict):
TokenDomains: NotRequired[List[str]],
APIKey: NotRequired[str],
CreationTimestamp: NotRequired[datetime],
Version: NotRequired[int],AWSManagedRulesBotControlRuleSetTypeDef#
# AWSManagedRulesBotControlRuleSetTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AWSManagedRulesBotControlRuleSetTypeDef
def get_value() -> AWSManagedRulesBotControlRuleSetTypeDef:
return {
"InspectionLevel": ...,
}
# AWSManagedRulesBotControlRuleSetTypeDef definition
class AWSManagedRulesBotControlRuleSetTypeDef(TypedDict):
InspectionLevel: InspectionLevelType, # (1)
EnableMachineLearning: NotRequired[bool],ActionConditionTypeDef#
# ActionConditionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ActionConditionTypeDef
def get_value() -> ActionConditionTypeDef:
return {
"Action": ...,
}
# ActionConditionTypeDef definition
class ActionConditionTypeDef(TypedDict):
Action: ActionValueType, # (1)- See ActionValueType
AddressFieldTypeDef#
# AddressFieldTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AddressFieldTypeDef
def get_value() -> AddressFieldTypeDef:
return {
"Identifier": ...,
}
# AddressFieldTypeDef definition
class AddressFieldTypeDef(TypedDict):
Identifier: str,AndStatementOutputTypeDef#
# AndStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AndStatementOutputTypeDef
def get_value() -> AndStatementOutputTypeDef:
return {
"Statements": ...,
}
# AndStatementOutputTypeDef definition
class AndStatementOutputTypeDef(TypedDict):
Statements: List[Dict[str, Any]],AndStatementTypeDef#
# AndStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AndStatementTypeDef
def get_value() -> AndStatementTypeDef:
return {
"Statements": ...,
}
# AndStatementTypeDef definition
class AndStatementTypeDef(TypedDict):
Statements: Sequence[Mapping[str, Any]],AssociateWebACLRequestTypeDef#
# AssociateWebACLRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AssociateWebACLRequestTypeDef
def get_value() -> AssociateWebACLRequestTypeDef:
return {
"WebACLArn": ...,
}
# AssociateWebACLRequestTypeDef definition
class AssociateWebACLRequestTypeDef(TypedDict):
WebACLArn: str,
ResourceArn: str,RequestBodyAssociatedResourceTypeConfigTypeDef#
# RequestBodyAssociatedResourceTypeConfigTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RequestBodyAssociatedResourceTypeConfigTypeDef
def get_value() -> RequestBodyAssociatedResourceTypeConfigTypeDef:
return {
"DefaultSizeInspectionLimit": ...,
}
# RequestBodyAssociatedResourceTypeConfigTypeDef definition
class RequestBodyAssociatedResourceTypeConfigTypeDef(TypedDict):
DefaultSizeInspectionLimit: SizeInspectionLimitType, # (1)BodyTypeDef#
# BodyTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import BodyTypeDef
def get_value() -> BodyTypeDef:
return {
"OversizeHandling": ...,
}
# BodyTypeDef definition
class BodyTypeDef(TypedDict):
OversizeHandling: NotRequired[OversizeHandlingType], # (1)TextTransformationTypeDef#
# TextTransformationTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import TextTransformationTypeDef
def get_value() -> TextTransformationTypeDef:
return {
"Priority": ...,
}
# TextTransformationTypeDef definition
class TextTransformationTypeDef(TypedDict):
Priority: int,
Type: TextTransformationTypeType, # (1)ImmunityTimePropertyTypeDef#
# ImmunityTimePropertyTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ImmunityTimePropertyTypeDef
def get_value() -> ImmunityTimePropertyTypeDef:
return {
"ImmunityTime": ...,
}
# ImmunityTimePropertyTypeDef definition
class ImmunityTimePropertyTypeDef(TypedDict):
ImmunityTime: int,CaptchaResponseTypeDef#
# CaptchaResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CaptchaResponseTypeDef
def get_value() -> CaptchaResponseTypeDef:
return {
"ResponseCode": ...,
}
# CaptchaResponseTypeDef definition
class CaptchaResponseTypeDef(TypedDict):
ResponseCode: NotRequired[int],
SolveTimestamp: NotRequired[int],
FailureReason: NotRequired[FailureReasonType], # (1)ChallengeResponseTypeDef#
# ChallengeResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ChallengeResponseTypeDef
def get_value() -> ChallengeResponseTypeDef:
return {
"ResponseCode": ...,
}
# ChallengeResponseTypeDef definition
class ChallengeResponseTypeDef(TypedDict):
ResponseCode: NotRequired[int],
SolveTimestamp: NotRequired[int],
FailureReason: NotRequired[FailureReasonType], # (1)ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],LabelNameConditionTypeDef#
# LabelNameConditionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import LabelNameConditionTypeDef
def get_value() -> LabelNameConditionTypeDef:
return {
"LabelName": ...,
}
# LabelNameConditionTypeDef definition
class LabelNameConditionTypeDef(TypedDict):
LabelName: str,CookieMatchPatternOutputTypeDef#
# CookieMatchPatternOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CookieMatchPatternOutputTypeDef
def get_value() -> CookieMatchPatternOutputTypeDef:
return {
"All": ...,
}
# CookieMatchPatternOutputTypeDef definition
class CookieMatchPatternOutputTypeDef(TypedDict):
All: NotRequired[Dict[str, Any]],
IncludedCookies: NotRequired[List[str]],
ExcludedCookies: NotRequired[List[str]],CookieMatchPatternTypeDef#
# CookieMatchPatternTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CookieMatchPatternTypeDef
def get_value() -> CookieMatchPatternTypeDef:
return {
"All": ...,
}
# CookieMatchPatternTypeDef definition
class CookieMatchPatternTypeDef(TypedDict):
All: NotRequired[Mapping[str, Any]],
IncludedCookies: NotRequired[Sequence[str]],
ExcludedCookies: NotRequired[Sequence[str]],CreateAPIKeyRequestTypeDef#
# CreateAPIKeyRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CreateAPIKeyRequestTypeDef
def get_value() -> CreateAPIKeyRequestTypeDef:
return {
"Scope": ...,
}
# CreateAPIKeyRequestTypeDef definition
class CreateAPIKeyRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
TokenDomains: Sequence[str],- See ScopeType
TagTypeDef#
# TagTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,IPSetSummaryTypeDef#
# IPSetSummaryTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import IPSetSummaryTypeDef
def get_value() -> IPSetSummaryTypeDef:
return {
"Name": ...,
}
# IPSetSummaryTypeDef definition
class IPSetSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
Description: NotRequired[str],
LockToken: NotRequired[str],
ARN: NotRequired[str],RegexTypeDef#
# RegexTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RegexTypeDef
def get_value() -> RegexTypeDef:
return {
"RegexString": ...,
}
# RegexTypeDef definition
class RegexTypeDef(TypedDict):
RegexString: NotRequired[str],RegexPatternSetSummaryTypeDef#
# RegexPatternSetSummaryTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RegexPatternSetSummaryTypeDef
def get_value() -> RegexPatternSetSummaryTypeDef:
return {
"Name": ...,
}
# RegexPatternSetSummaryTypeDef definition
class RegexPatternSetSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
Description: NotRequired[str],
LockToken: NotRequired[str],
ARN: NotRequired[str],CustomResponseBodyTypeDef#
# CustomResponseBodyTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CustomResponseBodyTypeDef
def get_value() -> CustomResponseBodyTypeDef:
return {
"ContentType": ...,
}
# CustomResponseBodyTypeDef definition
class CustomResponseBodyTypeDef(TypedDict):
ContentType: ResponseContentTypeType, # (1)
Content: str,VisibilityConfigTypeDef#
# VisibilityConfigTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import VisibilityConfigTypeDef
def get_value() -> VisibilityConfigTypeDef:
return {
"SampledRequestsEnabled": ...,
}
# VisibilityConfigTypeDef definition
class VisibilityConfigTypeDef(TypedDict):
SampledRequestsEnabled: bool,
CloudWatchMetricsEnabled: bool,
MetricName: str,RuleGroupSummaryTypeDef#
# RuleGroupSummaryTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RuleGroupSummaryTypeDef
def get_value() -> RuleGroupSummaryTypeDef:
return {
"Name": ...,
}
# RuleGroupSummaryTypeDef definition
class RuleGroupSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
Description: NotRequired[str],
LockToken: NotRequired[str],
ARN: NotRequired[str],WebACLSummaryTypeDef#
# WebACLSummaryTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import WebACLSummaryTypeDef
def get_value() -> WebACLSummaryTypeDef:
return {
"Name": ...,
}
# WebACLSummaryTypeDef definition
class WebACLSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
Description: NotRequired[str],
LockToken: NotRequired[str],
ARN: NotRequired[str],CustomHTTPHeaderTypeDef#
# CustomHTTPHeaderTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CustomHTTPHeaderTypeDef
def get_value() -> CustomHTTPHeaderTypeDef:
return {
"Name": ...,
}
# CustomHTTPHeaderTypeDef definition
class CustomHTTPHeaderTypeDef(TypedDict):
Name: str,
Value: str,FieldToProtectOutputTypeDef#
# FieldToProtectOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import FieldToProtectOutputTypeDef
def get_value() -> FieldToProtectOutputTypeDef:
return {
"FieldType": ...,
}
# FieldToProtectOutputTypeDef definition
class FieldToProtectOutputTypeDef(TypedDict):
FieldType: FieldToProtectTypeType, # (1)
FieldKeys: NotRequired[List[str]],FieldToProtectTypeDef#
# FieldToProtectTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import FieldToProtectTypeDef
def get_value() -> FieldToProtectTypeDef:
return {
"FieldType": ...,
}
# FieldToProtectTypeDef definition
class FieldToProtectTypeDef(TypedDict):
FieldType: FieldToProtectTypeType, # (1)
FieldKeys: NotRequired[Sequence[str]],DeleteAPIKeyRequestTypeDef#
# DeleteAPIKeyRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DeleteAPIKeyRequestTypeDef
def get_value() -> DeleteAPIKeyRequestTypeDef:
return {
"Scope": ...,
}
# DeleteAPIKeyRequestTypeDef definition
class DeleteAPIKeyRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
APIKey: str,- See ScopeType
DeleteFirewallManagerRuleGroupsRequestTypeDef#
# DeleteFirewallManagerRuleGroupsRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DeleteFirewallManagerRuleGroupsRequestTypeDef
def get_value() -> DeleteFirewallManagerRuleGroupsRequestTypeDef:
return {
"WebACLArn": ...,
}
# DeleteFirewallManagerRuleGroupsRequestTypeDef definition
class DeleteFirewallManagerRuleGroupsRequestTypeDef(TypedDict):
WebACLArn: str,
WebACLLockToken: str,DeleteIPSetRequestTypeDef#
# DeleteIPSetRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DeleteIPSetRequestTypeDef
def get_value() -> DeleteIPSetRequestTypeDef:
return {
"Name": ...,
}
# DeleteIPSetRequestTypeDef definition
class DeleteIPSetRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,- See ScopeType
DeleteLoggingConfigurationRequestTypeDef#
# DeleteLoggingConfigurationRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DeleteLoggingConfigurationRequestTypeDef
def get_value() -> DeleteLoggingConfigurationRequestTypeDef:
return {
"ResourceArn": ...,
}
# DeleteLoggingConfigurationRequestTypeDef definition
class DeleteLoggingConfigurationRequestTypeDef(TypedDict):
ResourceArn: str,
LogType: NotRequired[LogTypeType], # (1)
LogScope: NotRequired[LogScopeType], # (2)- See LogTypeType
- See LogScopeType
DeletePermissionPolicyRequestTypeDef#
# DeletePermissionPolicyRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DeletePermissionPolicyRequestTypeDef
def get_value() -> DeletePermissionPolicyRequestTypeDef:
return {
"ResourceArn": ...,
}
# DeletePermissionPolicyRequestTypeDef definition
class DeletePermissionPolicyRequestTypeDef(TypedDict):
ResourceArn: str,DeleteRegexPatternSetRequestTypeDef#
# DeleteRegexPatternSetRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DeleteRegexPatternSetRequestTypeDef
def get_value() -> DeleteRegexPatternSetRequestTypeDef:
return {
"Name": ...,
}
# DeleteRegexPatternSetRequestTypeDef definition
class DeleteRegexPatternSetRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,- See ScopeType
DeleteRuleGroupRequestTypeDef#
# DeleteRuleGroupRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DeleteRuleGroupRequestTypeDef
def get_value() -> DeleteRuleGroupRequestTypeDef:
return {
"Name": ...,
}
# DeleteRuleGroupRequestTypeDef definition
class DeleteRuleGroupRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,- See ScopeType
DeleteWebACLRequestTypeDef#
# DeleteWebACLRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DeleteWebACLRequestTypeDef
def get_value() -> DeleteWebACLRequestTypeDef:
return {
"Name": ...,
}
# DeleteWebACLRequestTypeDef definition
class DeleteWebACLRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,- See ScopeType
DescribeAllManagedProductsRequestTypeDef#
# DescribeAllManagedProductsRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DescribeAllManagedProductsRequestTypeDef
def get_value() -> DescribeAllManagedProductsRequestTypeDef:
return {
"Scope": ...,
}
# DescribeAllManagedProductsRequestTypeDef definition
class DescribeAllManagedProductsRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)- See ScopeType
ManagedProductDescriptorTypeDef#
# ManagedProductDescriptorTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ManagedProductDescriptorTypeDef
def get_value() -> ManagedProductDescriptorTypeDef:
return {
"VendorName": ...,
}
# ManagedProductDescriptorTypeDef definition
class ManagedProductDescriptorTypeDef(TypedDict):
VendorName: NotRequired[str],
ManagedRuleSetName: NotRequired[str],
ProductId: NotRequired[str],
ProductLink: NotRequired[str],
ProductTitle: NotRequired[str],
ProductDescription: NotRequired[str],
SnsTopicArn: NotRequired[str],
IsVersioningSupported: NotRequired[bool],
IsAdvancedManagedRuleSet: NotRequired[bool],DescribeManagedProductsByVendorRequestTypeDef#
# DescribeManagedProductsByVendorRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DescribeManagedProductsByVendorRequestTypeDef
def get_value() -> DescribeManagedProductsByVendorRequestTypeDef:
return {
"VendorName": ...,
}
# DescribeManagedProductsByVendorRequestTypeDef definition
class DescribeManagedProductsByVendorRequestTypeDef(TypedDict):
VendorName: str,
Scope: ScopeType, # (1)- See ScopeType
DescribeManagedRuleGroupRequestTypeDef#
# DescribeManagedRuleGroupRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DescribeManagedRuleGroupRequestTypeDef
def get_value() -> DescribeManagedRuleGroupRequestTypeDef:
return {
"VendorName": ...,
}
# DescribeManagedRuleGroupRequestTypeDef definition
class DescribeManagedRuleGroupRequestTypeDef(TypedDict):
VendorName: str,
Name: str,
Scope: ScopeType, # (1)
VersionName: NotRequired[str],- See ScopeType
LabelSummaryTypeDef#
# LabelSummaryTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import LabelSummaryTypeDef
def get_value() -> LabelSummaryTypeDef:
return {
"Name": ...,
}
# LabelSummaryTypeDef definition
class LabelSummaryTypeDef(TypedDict):
Name: NotRequired[str],DisassociateWebACLRequestTypeDef#
# DisassociateWebACLRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DisassociateWebACLRequestTypeDef
def get_value() -> DisassociateWebACLRequestTypeDef:
return {
"ResourceArn": ...,
}
# DisassociateWebACLRequestTypeDef definition
class DisassociateWebACLRequestTypeDef(TypedDict):
ResourceArn: str,EmailFieldTypeDef#
# EmailFieldTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import EmailFieldTypeDef
def get_value() -> EmailFieldTypeDef:
return {
"Identifier": ...,
}
# EmailFieldTypeDef definition
class EmailFieldTypeDef(TypedDict):
Identifier: str,ExcludedRuleTypeDef#
# ExcludedRuleTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ExcludedRuleTypeDef
def get_value() -> ExcludedRuleTypeDef:
return {
"Name": ...,
}
# ExcludedRuleTypeDef definition
class ExcludedRuleTypeDef(TypedDict):
Name: str,HeaderOrderTypeDef#
# HeaderOrderTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import HeaderOrderTypeDef
def get_value() -> HeaderOrderTypeDef:
return {
"OversizeHandling": ...,
}
# HeaderOrderTypeDef definition
class HeaderOrderTypeDef(TypedDict):
OversizeHandling: OversizeHandlingType, # (1)JA3FingerprintTypeDef#
# JA3FingerprintTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import JA3FingerprintTypeDef
def get_value() -> JA3FingerprintTypeDef:
return {
"FallbackBehavior": ...,
}
# JA3FingerprintTypeDef definition
class JA3FingerprintTypeDef(TypedDict):
FallbackBehavior: FallbackBehaviorType, # (1)SingleHeaderTypeDef#
# SingleHeaderTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import SingleHeaderTypeDef
def get_value() -> SingleHeaderTypeDef:
return {
"Name": ...,
}
# SingleHeaderTypeDef definition
class SingleHeaderTypeDef(TypedDict):
Name: str,SingleQueryArgumentTypeDef#
# SingleQueryArgumentTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import SingleQueryArgumentTypeDef
def get_value() -> SingleQueryArgumentTypeDef:
return {
"Name": ...,
}
# SingleQueryArgumentTypeDef definition
class SingleQueryArgumentTypeDef(TypedDict):
Name: str,ForwardedIPConfigTypeDef#
# ForwardedIPConfigTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ForwardedIPConfigTypeDef
def get_value() -> ForwardedIPConfigTypeDef:
return {
"HeaderName": ...,
}
# ForwardedIPConfigTypeDef definition
class ForwardedIPConfigTypeDef(TypedDict):
HeaderName: str,
FallbackBehavior: FallbackBehaviorType, # (1)GenerateMobileSdkReleaseUrlRequestTypeDef#
# GenerateMobileSdkReleaseUrlRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GenerateMobileSdkReleaseUrlRequestTypeDef
def get_value() -> GenerateMobileSdkReleaseUrlRequestTypeDef:
return {
"Platform": ...,
}
# GenerateMobileSdkReleaseUrlRequestTypeDef definition
class GenerateMobileSdkReleaseUrlRequestTypeDef(TypedDict):
Platform: PlatformType, # (1)
ReleaseVersion: str,- See PlatformType
GetDecryptedAPIKeyRequestTypeDef#
# GetDecryptedAPIKeyRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetDecryptedAPIKeyRequestTypeDef
def get_value() -> GetDecryptedAPIKeyRequestTypeDef:
return {
"Scope": ...,
}
# GetDecryptedAPIKeyRequestTypeDef definition
class GetDecryptedAPIKeyRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
APIKey: str,- See ScopeType
GetIPSetRequestTypeDef#
# GetIPSetRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetIPSetRequestTypeDef
def get_value() -> GetIPSetRequestTypeDef:
return {
"Name": ...,
}
# GetIPSetRequestTypeDef definition
class GetIPSetRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,- See ScopeType
IPSetTypeDef#
# IPSetTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import IPSetTypeDef
def get_value() -> IPSetTypeDef:
return {
"Name": ...,
}
# IPSetTypeDef definition
class IPSetTypeDef(TypedDict):
Name: str,
Id: str,
ARN: str,
IPAddressVersion: IPAddressVersionType, # (1)
Addresses: List[str],
Description: NotRequired[str],GetLoggingConfigurationRequestTypeDef#
# GetLoggingConfigurationRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetLoggingConfigurationRequestTypeDef
def get_value() -> GetLoggingConfigurationRequestTypeDef:
return {
"ResourceArn": ...,
}
# GetLoggingConfigurationRequestTypeDef definition
class GetLoggingConfigurationRequestTypeDef(TypedDict):
ResourceArn: str,
LogType: NotRequired[LogTypeType], # (1)
LogScope: NotRequired[LogScopeType], # (2)- See LogTypeType
- See LogScopeType
GetManagedRuleSetRequestTypeDef#
# GetManagedRuleSetRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetManagedRuleSetRequestTypeDef
def get_value() -> GetManagedRuleSetRequestTypeDef:
return {
"Name": ...,
}
# GetManagedRuleSetRequestTypeDef definition
class GetManagedRuleSetRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,- See ScopeType
GetMobileSdkReleaseRequestTypeDef#
# GetMobileSdkReleaseRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetMobileSdkReleaseRequestTypeDef
def get_value() -> GetMobileSdkReleaseRequestTypeDef:
return {
"Platform": ...,
}
# GetMobileSdkReleaseRequestTypeDef definition
class GetMobileSdkReleaseRequestTypeDef(TypedDict):
Platform: PlatformType, # (1)
ReleaseVersion: str,- See PlatformType
GetPermissionPolicyRequestTypeDef#
# GetPermissionPolicyRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetPermissionPolicyRequestTypeDef
def get_value() -> GetPermissionPolicyRequestTypeDef:
return {
"ResourceArn": ...,
}
# GetPermissionPolicyRequestTypeDef definition
class GetPermissionPolicyRequestTypeDef(TypedDict):
ResourceArn: str,GetRateBasedStatementManagedKeysRequestTypeDef#
# GetRateBasedStatementManagedKeysRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetRateBasedStatementManagedKeysRequestTypeDef
def get_value() -> GetRateBasedStatementManagedKeysRequestTypeDef:
return {
"Scope": ...,
}
# GetRateBasedStatementManagedKeysRequestTypeDef definition
class GetRateBasedStatementManagedKeysRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
WebACLName: str,
WebACLId: str,
RuleName: str,
RuleGroupRuleName: NotRequired[str],- See ScopeType
RateBasedStatementManagedKeysIPSetTypeDef#
# RateBasedStatementManagedKeysIPSetTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateBasedStatementManagedKeysIPSetTypeDef
def get_value() -> RateBasedStatementManagedKeysIPSetTypeDef:
return {
"IPAddressVersion": ...,
}
# RateBasedStatementManagedKeysIPSetTypeDef definition
class RateBasedStatementManagedKeysIPSetTypeDef(TypedDict):
IPAddressVersion: NotRequired[IPAddressVersionType], # (1)
Addresses: NotRequired[List[str]],GetRegexPatternSetRequestTypeDef#
# GetRegexPatternSetRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetRegexPatternSetRequestTypeDef
def get_value() -> GetRegexPatternSetRequestTypeDef:
return {
"Name": ...,
}
# GetRegexPatternSetRequestTypeDef definition
class GetRegexPatternSetRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,- See ScopeType
GetRuleGroupRequestTypeDef#
# GetRuleGroupRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetRuleGroupRequestTypeDef
def get_value() -> GetRuleGroupRequestTypeDef:
return {
"Name": ...,
}
# GetRuleGroupRequestTypeDef definition
class GetRuleGroupRequestTypeDef(TypedDict):
Name: NotRequired[str],
Scope: NotRequired[ScopeType], # (1)
Id: NotRequired[str],
ARN: NotRequired[str],- See ScopeType
TimeWindowOutputTypeDef#
# TimeWindowOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import TimeWindowOutputTypeDef
def get_value() -> TimeWindowOutputTypeDef:
return {
"StartTime": ...,
}
# TimeWindowOutputTypeDef definition
class TimeWindowOutputTypeDef(TypedDict):
StartTime: datetime,
EndTime: datetime,GetWebACLForResourceRequestTypeDef#
# GetWebACLForResourceRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetWebACLForResourceRequestTypeDef
def get_value() -> GetWebACLForResourceRequestTypeDef:
return {
"ResourceArn": ...,
}
# GetWebACLForResourceRequestTypeDef definition
class GetWebACLForResourceRequestTypeDef(TypedDict):
ResourceArn: str,GetWebACLRequestTypeDef#
# GetWebACLRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetWebACLRequestTypeDef
def get_value() -> GetWebACLRequestTypeDef:
return {
"Name": ...,
}
# GetWebACLRequestTypeDef definition
class GetWebACLRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,- See ScopeType
HTTPHeaderTypeDef#
# HTTPHeaderTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import HTTPHeaderTypeDef
def get_value() -> HTTPHeaderTypeDef:
return {
"Name": ...,
}
# HTTPHeaderTypeDef definition
class HTTPHeaderTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[str],HeaderMatchPatternOutputTypeDef#
# HeaderMatchPatternOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import HeaderMatchPatternOutputTypeDef
def get_value() -> HeaderMatchPatternOutputTypeDef:
return {
"All": ...,
}
# HeaderMatchPatternOutputTypeDef definition
class HeaderMatchPatternOutputTypeDef(TypedDict):
All: NotRequired[Dict[str, Any]],
IncludedHeaders: NotRequired[List[str]],
ExcludedHeaders: NotRequired[List[str]],HeaderMatchPatternTypeDef#
# HeaderMatchPatternTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import HeaderMatchPatternTypeDef
def get_value() -> HeaderMatchPatternTypeDef:
return {
"All": ...,
}
# HeaderMatchPatternTypeDef definition
class HeaderMatchPatternTypeDef(TypedDict):
All: NotRequired[Mapping[str, Any]],
IncludedHeaders: NotRequired[Sequence[str]],
ExcludedHeaders: NotRequired[Sequence[str]],IPSetForwardedIPConfigTypeDef#
# IPSetForwardedIPConfigTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import IPSetForwardedIPConfigTypeDef
def get_value() -> IPSetForwardedIPConfigTypeDef:
return {
"HeaderName": ...,
}
# IPSetForwardedIPConfigTypeDef definition
class IPSetForwardedIPConfigTypeDef(TypedDict):
HeaderName: str,
FallbackBehavior: FallbackBehaviorType, # (1)
Position: ForwardedIPPositionType, # (2)JsonMatchPatternOutputTypeDef#
# JsonMatchPatternOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import JsonMatchPatternOutputTypeDef
def get_value() -> JsonMatchPatternOutputTypeDef:
return {
"All": ...,
}
# JsonMatchPatternOutputTypeDef definition
class JsonMatchPatternOutputTypeDef(TypedDict):
All: NotRequired[Dict[str, Any]],
IncludedPaths: NotRequired[List[str]],JsonMatchPatternTypeDef#
# JsonMatchPatternTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import JsonMatchPatternTypeDef
def get_value() -> JsonMatchPatternTypeDef:
return {
"All": ...,
}
# JsonMatchPatternTypeDef definition
class JsonMatchPatternTypeDef(TypedDict):
All: NotRequired[Mapping[str, Any]],
IncludedPaths: NotRequired[Sequence[str]],LabelMatchStatementTypeDef#
# LabelMatchStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import LabelMatchStatementTypeDef
def get_value() -> LabelMatchStatementTypeDef:
return {
"Scope": ...,
}
# LabelMatchStatementTypeDef definition
class LabelMatchStatementTypeDef(TypedDict):
Scope: LabelMatchScopeType, # (1)
Key: str,LabelTypeDef#
# LabelTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import LabelTypeDef
def get_value() -> LabelTypeDef:
return {
"Name": ...,
}
# LabelTypeDef definition
class LabelTypeDef(TypedDict):
Name: str,ListAPIKeysRequestTypeDef#
# ListAPIKeysRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListAPIKeysRequestTypeDef
def get_value() -> ListAPIKeysRequestTypeDef:
return {
"Scope": ...,
}
# ListAPIKeysRequestTypeDef definition
class ListAPIKeysRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],- See ScopeType
ListAvailableManagedRuleGroupVersionsRequestTypeDef#
# ListAvailableManagedRuleGroupVersionsRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListAvailableManagedRuleGroupVersionsRequestTypeDef
def get_value() -> ListAvailableManagedRuleGroupVersionsRequestTypeDef:
return {
"VendorName": ...,
}
# ListAvailableManagedRuleGroupVersionsRequestTypeDef definition
class ListAvailableManagedRuleGroupVersionsRequestTypeDef(TypedDict):
VendorName: str,
Name: str,
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],- See ScopeType
ManagedRuleGroupVersionTypeDef#
# ManagedRuleGroupVersionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ManagedRuleGroupVersionTypeDef
def get_value() -> ManagedRuleGroupVersionTypeDef:
return {
"Name": ...,
}
# ManagedRuleGroupVersionTypeDef definition
class ManagedRuleGroupVersionTypeDef(TypedDict):
Name: NotRequired[str],
LastUpdateTimestamp: NotRequired[datetime],ListAvailableManagedRuleGroupsRequestTypeDef#
# ListAvailableManagedRuleGroupsRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListAvailableManagedRuleGroupsRequestTypeDef
def get_value() -> ListAvailableManagedRuleGroupsRequestTypeDef:
return {
"Scope": ...,
}
# ListAvailableManagedRuleGroupsRequestTypeDef definition
class ListAvailableManagedRuleGroupsRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],- See ScopeType
ManagedRuleGroupSummaryTypeDef#
# ManagedRuleGroupSummaryTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ManagedRuleGroupSummaryTypeDef
def get_value() -> ManagedRuleGroupSummaryTypeDef:
return {
"VendorName": ...,
}
# ManagedRuleGroupSummaryTypeDef definition
class ManagedRuleGroupSummaryTypeDef(TypedDict):
VendorName: NotRequired[str],
Name: NotRequired[str],
VersioningSupported: NotRequired[bool],
Description: NotRequired[str],ListIPSetsRequestTypeDef#
# ListIPSetsRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListIPSetsRequestTypeDef
def get_value() -> ListIPSetsRequestTypeDef:
return {
"Scope": ...,
}
# ListIPSetsRequestTypeDef definition
class ListIPSetsRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],- See ScopeType
ListLoggingConfigurationsRequestTypeDef#
# ListLoggingConfigurationsRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListLoggingConfigurationsRequestTypeDef
def get_value() -> ListLoggingConfigurationsRequestTypeDef:
return {
"Scope": ...,
}
# ListLoggingConfigurationsRequestTypeDef definition
class ListLoggingConfigurationsRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],
LogScope: NotRequired[LogScopeType], # (2)- See ScopeType
- See LogScopeType
ListManagedRuleSetsRequestTypeDef#
# ListManagedRuleSetsRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListManagedRuleSetsRequestTypeDef
def get_value() -> ListManagedRuleSetsRequestTypeDef:
return {
"Scope": ...,
}
# ListManagedRuleSetsRequestTypeDef definition
class ListManagedRuleSetsRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],- See ScopeType
ManagedRuleSetSummaryTypeDef#
# ManagedRuleSetSummaryTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ManagedRuleSetSummaryTypeDef
def get_value() -> ManagedRuleSetSummaryTypeDef:
return {
"Name": ...,
}
# ManagedRuleSetSummaryTypeDef definition
class ManagedRuleSetSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
Description: NotRequired[str],
LockToken: NotRequired[str],
ARN: NotRequired[str],
LabelNamespace: NotRequired[str],ListMobileSdkReleasesRequestTypeDef#
# ListMobileSdkReleasesRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListMobileSdkReleasesRequestTypeDef
def get_value() -> ListMobileSdkReleasesRequestTypeDef:
return {
"Platform": ...,
}
# ListMobileSdkReleasesRequestTypeDef definition
class ListMobileSdkReleasesRequestTypeDef(TypedDict):
Platform: PlatformType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],- See PlatformType
ReleaseSummaryTypeDef#
# ReleaseSummaryTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ReleaseSummaryTypeDef
def get_value() -> ReleaseSummaryTypeDef:
return {
"ReleaseVersion": ...,
}
# ReleaseSummaryTypeDef definition
class ReleaseSummaryTypeDef(TypedDict):
ReleaseVersion: NotRequired[str],
Timestamp: NotRequired[datetime],ListRegexPatternSetsRequestTypeDef#
# ListRegexPatternSetsRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListRegexPatternSetsRequestTypeDef
def get_value() -> ListRegexPatternSetsRequestTypeDef:
return {
"Scope": ...,
}
# ListRegexPatternSetsRequestTypeDef definition
class ListRegexPatternSetsRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],- See ScopeType
ListResourcesForWebACLRequestTypeDef#
# ListResourcesForWebACLRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListResourcesForWebACLRequestTypeDef
def get_value() -> ListResourcesForWebACLRequestTypeDef:
return {
"WebACLArn": ...,
}
# ListResourcesForWebACLRequestTypeDef definition
class ListResourcesForWebACLRequestTypeDef(TypedDict):
WebACLArn: str,
ResourceType: NotRequired[ResourceTypeType], # (1)- See ResourceTypeType
ListRuleGroupsRequestTypeDef#
# ListRuleGroupsRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListRuleGroupsRequestTypeDef
def get_value() -> ListRuleGroupsRequestTypeDef:
return {
"Scope": ...,
}
# ListRuleGroupsRequestTypeDef definition
class ListRuleGroupsRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],- See ScopeType
ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"ResourceARN": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
ResourceARN: str,
NextMarker: NotRequired[str],
Limit: NotRequired[int],ListWebACLsRequestTypeDef#
# ListWebACLsRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListWebACLsRequestTypeDef
def get_value() -> ListWebACLsRequestTypeDef:
return {
"Scope": ...,
}
# ListWebACLsRequestTypeDef definition
class ListWebACLsRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],- See ScopeType
PasswordFieldTypeDef#
# PasswordFieldTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import PasswordFieldTypeDef
def get_value() -> PasswordFieldTypeDef:
return {
"Identifier": ...,
}
# PasswordFieldTypeDef definition
class PasswordFieldTypeDef(TypedDict):
Identifier: str,UsernameFieldTypeDef#
# UsernameFieldTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import UsernameFieldTypeDef
def get_value() -> UsernameFieldTypeDef:
return {
"Identifier": ...,
}
# UsernameFieldTypeDef definition
class UsernameFieldTypeDef(TypedDict):
Identifier: str,ManagedRuleSetVersionTypeDef#
# ManagedRuleSetVersionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ManagedRuleSetVersionTypeDef
def get_value() -> ManagedRuleSetVersionTypeDef:
return {
"AssociatedRuleGroupArn": ...,
}
# ManagedRuleSetVersionTypeDef definition
class ManagedRuleSetVersionTypeDef(TypedDict):
AssociatedRuleGroupArn: NotRequired[str],
Capacity: NotRequired[int],
ForecastedLifetime: NotRequired[int],
PublishTimestamp: NotRequired[datetime],
LastUpdateTimestamp: NotRequired[datetime],
ExpiryTimestamp: NotRequired[datetime],NotStatementOutputTypeDef#
# NotStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import NotStatementOutputTypeDef
def get_value() -> NotStatementOutputTypeDef:
return {
"Statement": ...,
}
# NotStatementOutputTypeDef definition
class NotStatementOutputTypeDef(TypedDict):
Statement: Dict[str, Any],NotStatementTypeDef#
# NotStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import NotStatementTypeDef
def get_value() -> NotStatementTypeDef:
return {
"Statement": ...,
}
# NotStatementTypeDef definition
class NotStatementTypeDef(TypedDict):
Statement: Mapping[str, Any],OrStatementOutputTypeDef#
# OrStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import OrStatementOutputTypeDef
def get_value() -> OrStatementOutputTypeDef:
return {
"Statements": ...,
}
# OrStatementOutputTypeDef definition
class OrStatementOutputTypeDef(TypedDict):
Statements: List[Dict[str, Any]],OrStatementTypeDef#
# OrStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import OrStatementTypeDef
def get_value() -> OrStatementTypeDef:
return {
"Statements": ...,
}
# OrStatementTypeDef definition
class OrStatementTypeDef(TypedDict):
Statements: Sequence[Mapping[str, Any]],PhoneNumberFieldTypeDef#
# PhoneNumberFieldTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import PhoneNumberFieldTypeDef
def get_value() -> PhoneNumberFieldTypeDef:
return {
"Identifier": ...,
}
# PhoneNumberFieldTypeDef definition
class PhoneNumberFieldTypeDef(TypedDict):
Identifier: str,VersionToPublishTypeDef#
# VersionToPublishTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import VersionToPublishTypeDef
def get_value() -> VersionToPublishTypeDef:
return {
"AssociatedRuleGroupArn": ...,
}
# VersionToPublishTypeDef definition
class VersionToPublishTypeDef(TypedDict):
AssociatedRuleGroupArn: NotRequired[str],
ForecastedLifetime: NotRequired[int],PutPermissionPolicyRequestTypeDef#
# PutPermissionPolicyRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import PutPermissionPolicyRequestTypeDef
def get_value() -> PutPermissionPolicyRequestTypeDef:
return {
"ResourceArn": ...,
}
# PutPermissionPolicyRequestTypeDef definition
class PutPermissionPolicyRequestTypeDef(TypedDict):
ResourceArn: str,
Policy: str,RateLimitLabelNamespaceTypeDef#
# RateLimitLabelNamespaceTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateLimitLabelNamespaceTypeDef
def get_value() -> RateLimitLabelNamespaceTypeDef:
return {
"Namespace": ...,
}
# RateLimitLabelNamespaceTypeDef definition
class RateLimitLabelNamespaceTypeDef(TypedDict):
Namespace: str,ResponseInspectionBodyContainsOutputTypeDef#
# ResponseInspectionBodyContainsOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ResponseInspectionBodyContainsOutputTypeDef
def get_value() -> ResponseInspectionBodyContainsOutputTypeDef:
return {
"SuccessStrings": ...,
}
# ResponseInspectionBodyContainsOutputTypeDef definition
class ResponseInspectionBodyContainsOutputTypeDef(TypedDict):
SuccessStrings: List[str],
FailureStrings: List[str],ResponseInspectionBodyContainsTypeDef#
# ResponseInspectionBodyContainsTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ResponseInspectionBodyContainsTypeDef
def get_value() -> ResponseInspectionBodyContainsTypeDef:
return {
"SuccessStrings": ...,
}
# ResponseInspectionBodyContainsTypeDef definition
class ResponseInspectionBodyContainsTypeDef(TypedDict):
SuccessStrings: Sequence[str],
FailureStrings: Sequence[str],ResponseInspectionHeaderOutputTypeDef#
# ResponseInspectionHeaderOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ResponseInspectionHeaderOutputTypeDef
def get_value() -> ResponseInspectionHeaderOutputTypeDef:
return {
"Name": ...,
}
# ResponseInspectionHeaderOutputTypeDef definition
class ResponseInspectionHeaderOutputTypeDef(TypedDict):
Name: str,
SuccessValues: List[str],
FailureValues: List[str],ResponseInspectionHeaderTypeDef#
# ResponseInspectionHeaderTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ResponseInspectionHeaderTypeDef
def get_value() -> ResponseInspectionHeaderTypeDef:
return {
"Name": ...,
}
# ResponseInspectionHeaderTypeDef definition
class ResponseInspectionHeaderTypeDef(TypedDict):
Name: str,
SuccessValues: Sequence[str],
FailureValues: Sequence[str],ResponseInspectionJsonOutputTypeDef#
# ResponseInspectionJsonOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ResponseInspectionJsonOutputTypeDef
def get_value() -> ResponseInspectionJsonOutputTypeDef:
return {
"Identifier": ...,
}
# ResponseInspectionJsonOutputTypeDef definition
class ResponseInspectionJsonOutputTypeDef(TypedDict):
Identifier: str,
SuccessValues: List[str],
FailureValues: List[str],ResponseInspectionJsonTypeDef#
# ResponseInspectionJsonTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ResponseInspectionJsonTypeDef
def get_value() -> ResponseInspectionJsonTypeDef:
return {
"Identifier": ...,
}
# ResponseInspectionJsonTypeDef definition
class ResponseInspectionJsonTypeDef(TypedDict):
Identifier: str,
SuccessValues: Sequence[str],
FailureValues: Sequence[str],ResponseInspectionStatusCodeOutputTypeDef#
# ResponseInspectionStatusCodeOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ResponseInspectionStatusCodeOutputTypeDef
def get_value() -> ResponseInspectionStatusCodeOutputTypeDef:
return {
"SuccessCodes": ...,
}
# ResponseInspectionStatusCodeOutputTypeDef definition
class ResponseInspectionStatusCodeOutputTypeDef(TypedDict):
SuccessCodes: List[int],
FailureCodes: List[int],ResponseInspectionStatusCodeTypeDef#
# ResponseInspectionStatusCodeTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ResponseInspectionStatusCodeTypeDef
def get_value() -> ResponseInspectionStatusCodeTypeDef:
return {
"SuccessCodes": ...,
}
# ResponseInspectionStatusCodeTypeDef definition
class ResponseInspectionStatusCodeTypeDef(TypedDict):
SuccessCodes: Sequence[int],
FailureCodes: Sequence[int],UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"ResourceARN": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],UpdateIPSetRequestTypeDef#
# UpdateIPSetRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import UpdateIPSetRequestTypeDef
def get_value() -> UpdateIPSetRequestTypeDef:
return {
"Name": ...,
}
# UpdateIPSetRequestTypeDef definition
class UpdateIPSetRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
Addresses: Sequence[str],
LockToken: str,
Description: NotRequired[str],- See ScopeType
AssociationConfigOutputTypeDef#
# AssociationConfigOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AssociationConfigOutputTypeDef
def get_value() -> AssociationConfigOutputTypeDef:
return {
"RequestBody": ...,
}
# AssociationConfigOutputTypeDef definition
class AssociationConfigOutputTypeDef(TypedDict):
RequestBody: NotRequired[Dict[AssociatedResourceTypeType, RequestBodyAssociatedResourceTypeConfigTypeDef]], # (1)AssociationConfigTypeDef#
# AssociationConfigTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AssociationConfigTypeDef
def get_value() -> AssociationConfigTypeDef:
return {
"RequestBody": ...,
}
# AssociationConfigTypeDef definition
class AssociationConfigTypeDef(TypedDict):
RequestBody: NotRequired[Mapping[AssociatedResourceTypeType, RequestBodyAssociatedResourceTypeConfigTypeDef]], # (1)RateLimitCookieOutputTypeDef#
# RateLimitCookieOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateLimitCookieOutputTypeDef
def get_value() -> RateLimitCookieOutputTypeDef:
return {
"Name": ...,
}
# RateLimitCookieOutputTypeDef definition
class RateLimitCookieOutputTypeDef(TypedDict):
Name: str,
TextTransformations: List[TextTransformationTypeDef], # (1)RateLimitCookieTypeDef#
# RateLimitCookieTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateLimitCookieTypeDef
def get_value() -> RateLimitCookieTypeDef:
return {
"Name": ...,
}
# RateLimitCookieTypeDef definition
class RateLimitCookieTypeDef(TypedDict):
Name: str,
TextTransformations: Sequence[TextTransformationTypeDef], # (1)RateLimitHeaderOutputTypeDef#
# RateLimitHeaderOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateLimitHeaderOutputTypeDef
def get_value() -> RateLimitHeaderOutputTypeDef:
return {
"Name": ...,
}
# RateLimitHeaderOutputTypeDef definition
class RateLimitHeaderOutputTypeDef(TypedDict):
Name: str,
TextTransformations: List[TextTransformationTypeDef], # (1)RateLimitHeaderTypeDef#
# RateLimitHeaderTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateLimitHeaderTypeDef
def get_value() -> RateLimitHeaderTypeDef:
return {
"Name": ...,
}
# RateLimitHeaderTypeDef definition
class RateLimitHeaderTypeDef(TypedDict):
Name: str,
TextTransformations: Sequence[TextTransformationTypeDef], # (1)RateLimitQueryArgumentOutputTypeDef#
# RateLimitQueryArgumentOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateLimitQueryArgumentOutputTypeDef
def get_value() -> RateLimitQueryArgumentOutputTypeDef:
return {
"Name": ...,
}
# RateLimitQueryArgumentOutputTypeDef definition
class RateLimitQueryArgumentOutputTypeDef(TypedDict):
Name: str,
TextTransformations: List[TextTransformationTypeDef], # (1)RateLimitQueryArgumentTypeDef#
# RateLimitQueryArgumentTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateLimitQueryArgumentTypeDef
def get_value() -> RateLimitQueryArgumentTypeDef:
return {
"Name": ...,
}
# RateLimitQueryArgumentTypeDef definition
class RateLimitQueryArgumentTypeDef(TypedDict):
Name: str,
TextTransformations: Sequence[TextTransformationTypeDef], # (1)RateLimitQueryStringOutputTypeDef#
# RateLimitQueryStringOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateLimitQueryStringOutputTypeDef
def get_value() -> RateLimitQueryStringOutputTypeDef:
return {
"TextTransformations": ...,
}
# RateLimitQueryStringOutputTypeDef definition
class RateLimitQueryStringOutputTypeDef(TypedDict):
TextTransformations: List[TextTransformationTypeDef], # (1)RateLimitQueryStringTypeDef#
# RateLimitQueryStringTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateLimitQueryStringTypeDef
def get_value() -> RateLimitQueryStringTypeDef:
return {
"TextTransformations": ...,
}
# RateLimitQueryStringTypeDef definition
class RateLimitQueryStringTypeDef(TypedDict):
TextTransformations: Sequence[TextTransformationTypeDef], # (1)RateLimitUriPathOutputTypeDef#
# RateLimitUriPathOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateLimitUriPathOutputTypeDef
def get_value() -> RateLimitUriPathOutputTypeDef:
return {
"TextTransformations": ...,
}
# RateLimitUriPathOutputTypeDef definition
class RateLimitUriPathOutputTypeDef(TypedDict):
TextTransformations: List[TextTransformationTypeDef], # (1)RateLimitUriPathTypeDef#
# RateLimitUriPathTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateLimitUriPathTypeDef
def get_value() -> RateLimitUriPathTypeDef:
return {
"TextTransformations": ...,
}
# RateLimitUriPathTypeDef definition
class RateLimitUriPathTypeDef(TypedDict):
TextTransformations: Sequence[TextTransformationTypeDef], # (1)CaptchaConfigTypeDef#
# CaptchaConfigTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CaptchaConfigTypeDef
def get_value() -> CaptchaConfigTypeDef:
return {
"ImmunityTimeProperty": ...,
}
# CaptchaConfigTypeDef definition
class CaptchaConfigTypeDef(TypedDict):
ImmunityTimeProperty: NotRequired[ImmunityTimePropertyTypeDef], # (1)ChallengeConfigTypeDef#
# ChallengeConfigTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ChallengeConfigTypeDef
def get_value() -> ChallengeConfigTypeDef:
return {
"ImmunityTimeProperty": ...,
}
# ChallengeConfigTypeDef definition
class ChallengeConfigTypeDef(TypedDict):
ImmunityTimeProperty: NotRequired[ImmunityTimePropertyTypeDef], # (1)CheckCapacityResponseTypeDef#
# CheckCapacityResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CheckCapacityResponseTypeDef
def get_value() -> CheckCapacityResponseTypeDef:
return {
"Capacity": ...,
}
# CheckCapacityResponseTypeDef definition
class CheckCapacityResponseTypeDef(TypedDict):
Capacity: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateAPIKeyResponseTypeDef#
# CreateAPIKeyResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CreateAPIKeyResponseTypeDef
def get_value() -> CreateAPIKeyResponseTypeDef:
return {
"APIKey": ...,
}
# CreateAPIKeyResponseTypeDef definition
class CreateAPIKeyResponseTypeDef(TypedDict):
APIKey: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DeleteFirewallManagerRuleGroupsResponseTypeDef#
# DeleteFirewallManagerRuleGroupsResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DeleteFirewallManagerRuleGroupsResponseTypeDef
def get_value() -> DeleteFirewallManagerRuleGroupsResponseTypeDef:
return {
"NextWebACLLockToken": ...,
}
# DeleteFirewallManagerRuleGroupsResponseTypeDef definition
class DeleteFirewallManagerRuleGroupsResponseTypeDef(TypedDict):
NextWebACLLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GenerateMobileSdkReleaseUrlResponseTypeDef#
# GenerateMobileSdkReleaseUrlResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GenerateMobileSdkReleaseUrlResponseTypeDef
def get_value() -> GenerateMobileSdkReleaseUrlResponseTypeDef:
return {
"Url": ...,
}
# GenerateMobileSdkReleaseUrlResponseTypeDef definition
class GenerateMobileSdkReleaseUrlResponseTypeDef(TypedDict):
Url: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetDecryptedAPIKeyResponseTypeDef#
# GetDecryptedAPIKeyResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetDecryptedAPIKeyResponseTypeDef
def get_value() -> GetDecryptedAPIKeyResponseTypeDef:
return {
"TokenDomains": ...,
}
# GetDecryptedAPIKeyResponseTypeDef definition
class GetDecryptedAPIKeyResponseTypeDef(TypedDict):
TokenDomains: List[str],
CreationTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetPermissionPolicyResponseTypeDef#
# GetPermissionPolicyResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetPermissionPolicyResponseTypeDef
def get_value() -> GetPermissionPolicyResponseTypeDef:
return {
"Policy": ...,
}
# GetPermissionPolicyResponseTypeDef definition
class GetPermissionPolicyResponseTypeDef(TypedDict):
Policy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListAPIKeysResponseTypeDef#
# ListAPIKeysResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListAPIKeysResponseTypeDef
def get_value() -> ListAPIKeysResponseTypeDef:
return {
"NextMarker": ...,
}
# ListAPIKeysResponseTypeDef definition
class ListAPIKeysResponseTypeDef(TypedDict):
NextMarker: str,
APIKeySummaries: List[APIKeySummaryTypeDef], # (1)
ApplicationIntegrationURL: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListResourcesForWebACLResponseTypeDef#
# ListResourcesForWebACLResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListResourcesForWebACLResponseTypeDef
def get_value() -> ListResourcesForWebACLResponseTypeDef:
return {
"ResourceArns": ...,
}
# ListResourcesForWebACLResponseTypeDef definition
class ListResourcesForWebACLResponseTypeDef(TypedDict):
ResourceArns: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)PutManagedRuleSetVersionsResponseTypeDef#
# PutManagedRuleSetVersionsResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import PutManagedRuleSetVersionsResponseTypeDef
def get_value() -> PutManagedRuleSetVersionsResponseTypeDef:
return {
"NextLockToken": ...,
}
# PutManagedRuleSetVersionsResponseTypeDef definition
class PutManagedRuleSetVersionsResponseTypeDef(TypedDict):
NextLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateIPSetResponseTypeDef#
# UpdateIPSetResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import UpdateIPSetResponseTypeDef
def get_value() -> UpdateIPSetResponseTypeDef:
return {
"NextLockToken": ...,
}
# UpdateIPSetResponseTypeDef definition
class UpdateIPSetResponseTypeDef(TypedDict):
NextLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateManagedRuleSetVersionExpiryDateResponseTypeDef#
# UpdateManagedRuleSetVersionExpiryDateResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import UpdateManagedRuleSetVersionExpiryDateResponseTypeDef
def get_value() -> UpdateManagedRuleSetVersionExpiryDateResponseTypeDef:
return {
"ExpiringVersion": ...,
}
# UpdateManagedRuleSetVersionExpiryDateResponseTypeDef definition
class UpdateManagedRuleSetVersionExpiryDateResponseTypeDef(TypedDict):
ExpiringVersion: str,
ExpiryTimestamp: datetime,
NextLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateRegexPatternSetResponseTypeDef#
# UpdateRegexPatternSetResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import UpdateRegexPatternSetResponseTypeDef
def get_value() -> UpdateRegexPatternSetResponseTypeDef:
return {
"NextLockToken": ...,
}
# UpdateRegexPatternSetResponseTypeDef definition
class UpdateRegexPatternSetResponseTypeDef(TypedDict):
NextLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateRuleGroupResponseTypeDef#
# UpdateRuleGroupResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import UpdateRuleGroupResponseTypeDef
def get_value() -> UpdateRuleGroupResponseTypeDef:
return {
"NextLockToken": ...,
}
# UpdateRuleGroupResponseTypeDef definition
class UpdateRuleGroupResponseTypeDef(TypedDict):
NextLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateWebACLResponseTypeDef#
# UpdateWebACLResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import UpdateWebACLResponseTypeDef
def get_value() -> UpdateWebACLResponseTypeDef:
return {
"NextLockToken": ...,
}
# UpdateWebACLResponseTypeDef definition
class UpdateWebACLResponseTypeDef(TypedDict):
NextLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ConditionTypeDef#
# ConditionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ConditionTypeDef
def get_value() -> ConditionTypeDef:
return {
"ActionCondition": ...,
}
# ConditionTypeDef definition
class ConditionTypeDef(TypedDict):
ActionCondition: NotRequired[ActionConditionTypeDef], # (1)
LabelNameCondition: NotRequired[LabelNameConditionTypeDef], # (2)CookiesOutputTypeDef#
# CookiesOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CookiesOutputTypeDef
def get_value() -> CookiesOutputTypeDef:
return {
"MatchPattern": ...,
}
# CookiesOutputTypeDef definition
class CookiesOutputTypeDef(TypedDict):
MatchPattern: CookieMatchPatternOutputTypeDef, # (1)
MatchScope: MapMatchScopeType, # (2)
OversizeHandling: OversizeHandlingType, # (3)CreateIPSetRequestTypeDef#
# CreateIPSetRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CreateIPSetRequestTypeDef
def get_value() -> CreateIPSetRequestTypeDef:
return {
"Name": ...,
}
# CreateIPSetRequestTypeDef definition
class CreateIPSetRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
IPAddressVersion: IPAddressVersionType, # (2)
Addresses: Sequence[str],
Description: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (3)- See ScopeType
- See IPAddressVersionType
- See TagTypeDef
MobileSdkReleaseTypeDef#
# MobileSdkReleaseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import MobileSdkReleaseTypeDef
def get_value() -> MobileSdkReleaseTypeDef:
return {
"ReleaseVersion": ...,
}
# MobileSdkReleaseTypeDef definition
class MobileSdkReleaseTypeDef(TypedDict):
ReleaseVersion: NotRequired[str],
Timestamp: NotRequired[datetime],
ReleaseNotes: NotRequired[str],
Tags: NotRequired[List[TagTypeDef]], # (1)- See TagTypeDef
TagInfoForResourceTypeDef#
# TagInfoForResourceTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import TagInfoForResourceTypeDef
def get_value() -> TagInfoForResourceTypeDef:
return {
"ResourceARN": ...,
}
# TagInfoForResourceTypeDef definition
class TagInfoForResourceTypeDef(TypedDict):
ResourceARN: NotRequired[str],
TagList: NotRequired[List[TagTypeDef]], # (1)- See TagTypeDef
TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"ResourceARN": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)- See TagTypeDef
CreateIPSetResponseTypeDef#
# CreateIPSetResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CreateIPSetResponseTypeDef
def get_value() -> CreateIPSetResponseTypeDef:
return {
"Summary": ...,
}
# CreateIPSetResponseTypeDef definition
class CreateIPSetResponseTypeDef(TypedDict):
Summary: IPSetSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListIPSetsResponseTypeDef#
# ListIPSetsResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListIPSetsResponseTypeDef
def get_value() -> ListIPSetsResponseTypeDef:
return {
"NextMarker": ...,
}
# ListIPSetsResponseTypeDef definition
class ListIPSetsResponseTypeDef(TypedDict):
NextMarker: str,
IPSets: List[IPSetSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateRegexPatternSetRequestTypeDef#
# CreateRegexPatternSetRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CreateRegexPatternSetRequestTypeDef
def get_value() -> CreateRegexPatternSetRequestTypeDef:
return {
"Name": ...,
}
# CreateRegexPatternSetRequestTypeDef definition
class CreateRegexPatternSetRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
RegularExpressionList: Sequence[RegexTypeDef], # (2)
Description: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (3)- See ScopeType
- See RegexTypeDef
- See TagTypeDef
RegexPatternSetTypeDef#
# RegexPatternSetTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RegexPatternSetTypeDef
def get_value() -> RegexPatternSetTypeDef:
return {
"Name": ...,
}
# RegexPatternSetTypeDef definition
class RegexPatternSetTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
ARN: NotRequired[str],
Description: NotRequired[str],
RegularExpressionList: NotRequired[List[RegexTypeDef]], # (1)- See RegexTypeDef
UpdateRegexPatternSetRequestTypeDef#
# UpdateRegexPatternSetRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import UpdateRegexPatternSetRequestTypeDef
def get_value() -> UpdateRegexPatternSetRequestTypeDef:
return {
"Name": ...,
}
# UpdateRegexPatternSetRequestTypeDef definition
class UpdateRegexPatternSetRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
RegularExpressionList: Sequence[RegexTypeDef], # (2)
LockToken: str,
Description: NotRequired[str],- See ScopeType
- See RegexTypeDef
CreateRegexPatternSetResponseTypeDef#
# CreateRegexPatternSetResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CreateRegexPatternSetResponseTypeDef
def get_value() -> CreateRegexPatternSetResponseTypeDef:
return {
"Summary": ...,
}
# CreateRegexPatternSetResponseTypeDef definition
class CreateRegexPatternSetResponseTypeDef(TypedDict):
Summary: RegexPatternSetSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListRegexPatternSetsResponseTypeDef#
# ListRegexPatternSetsResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListRegexPatternSetsResponseTypeDef
def get_value() -> ListRegexPatternSetsResponseTypeDef:
return {
"NextMarker": ...,
}
# ListRegexPatternSetsResponseTypeDef definition
class ListRegexPatternSetsResponseTypeDef(TypedDict):
NextMarker: str,
RegexPatternSets: List[RegexPatternSetSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateRuleGroupResponseTypeDef#
# CreateRuleGroupResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CreateRuleGroupResponseTypeDef
def get_value() -> CreateRuleGroupResponseTypeDef:
return {
"Summary": ...,
}
# CreateRuleGroupResponseTypeDef definition
class CreateRuleGroupResponseTypeDef(TypedDict):
Summary: RuleGroupSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListRuleGroupsResponseTypeDef#
# ListRuleGroupsResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListRuleGroupsResponseTypeDef
def get_value() -> ListRuleGroupsResponseTypeDef:
return {
"NextMarker": ...,
}
# ListRuleGroupsResponseTypeDef definition
class ListRuleGroupsResponseTypeDef(TypedDict):
NextMarker: str,
RuleGroups: List[RuleGroupSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateWebACLResponseTypeDef#
# CreateWebACLResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CreateWebACLResponseTypeDef
def get_value() -> CreateWebACLResponseTypeDef:
return {
"Summary": ...,
}
# CreateWebACLResponseTypeDef definition
class CreateWebACLResponseTypeDef(TypedDict):
Summary: WebACLSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListWebACLsResponseTypeDef#
# ListWebACLsResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListWebACLsResponseTypeDef
def get_value() -> ListWebACLsResponseTypeDef:
return {
"NextMarker": ...,
}
# ListWebACLsResponseTypeDef definition
class ListWebACLsResponseTypeDef(TypedDict):
NextMarker: str,
WebACLs: List[WebACLSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CustomRequestHandlingOutputTypeDef#
# CustomRequestHandlingOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CustomRequestHandlingOutputTypeDef
def get_value() -> CustomRequestHandlingOutputTypeDef:
return {
"InsertHeaders": ...,
}
# CustomRequestHandlingOutputTypeDef definition
class CustomRequestHandlingOutputTypeDef(TypedDict):
InsertHeaders: List[CustomHTTPHeaderTypeDef], # (1)CustomRequestHandlingTypeDef#
# CustomRequestHandlingTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CustomRequestHandlingTypeDef
def get_value() -> CustomRequestHandlingTypeDef:
return {
"InsertHeaders": ...,
}
# CustomRequestHandlingTypeDef definition
class CustomRequestHandlingTypeDef(TypedDict):
InsertHeaders: Sequence[CustomHTTPHeaderTypeDef], # (1)CustomResponseOutputTypeDef#
# CustomResponseOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CustomResponseOutputTypeDef
def get_value() -> CustomResponseOutputTypeDef:
return {
"ResponseCode": ...,
}
# CustomResponseOutputTypeDef definition
class CustomResponseOutputTypeDef(TypedDict):
ResponseCode: int,
CustomResponseBodyKey: NotRequired[str],
ResponseHeaders: NotRequired[List[CustomHTTPHeaderTypeDef]], # (1)CustomResponseTypeDef#
# CustomResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CustomResponseTypeDef
def get_value() -> CustomResponseTypeDef:
return {
"ResponseCode": ...,
}
# CustomResponseTypeDef definition
class CustomResponseTypeDef(TypedDict):
ResponseCode: int,
CustomResponseBodyKey: NotRequired[str],
ResponseHeaders: NotRequired[Sequence[CustomHTTPHeaderTypeDef]], # (1)DataProtectionOutputTypeDef#
# DataProtectionOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DataProtectionOutputTypeDef
def get_value() -> DataProtectionOutputTypeDef:
return {
"Field": ...,
}
# DataProtectionOutputTypeDef definition
class DataProtectionOutputTypeDef(TypedDict):
Field: FieldToProtectOutputTypeDef, # (1)
Action: DataProtectionActionType, # (2)
ExcludeRuleMatchDetails: NotRequired[bool],
ExcludeRateBasedDetails: NotRequired[bool],DataProtectionTypeDef#
# DataProtectionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DataProtectionTypeDef
def get_value() -> DataProtectionTypeDef:
return {
"Field": ...,
}
# DataProtectionTypeDef definition
class DataProtectionTypeDef(TypedDict):
Field: FieldToProtectTypeDef, # (1)
Action: DataProtectionActionType, # (2)
ExcludeRuleMatchDetails: NotRequired[bool],
ExcludeRateBasedDetails: NotRequired[bool],DescribeAllManagedProductsResponseTypeDef#
# DescribeAllManagedProductsResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DescribeAllManagedProductsResponseTypeDef
def get_value() -> DescribeAllManagedProductsResponseTypeDef:
return {
"ManagedProducts": ...,
}
# DescribeAllManagedProductsResponseTypeDef definition
class DescribeAllManagedProductsResponseTypeDef(TypedDict):
ManagedProducts: List[ManagedProductDescriptorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeManagedProductsByVendorResponseTypeDef#
# DescribeManagedProductsByVendorResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DescribeManagedProductsByVendorResponseTypeDef
def get_value() -> DescribeManagedProductsByVendorResponseTypeDef:
return {
"ManagedProducts": ...,
}
# DescribeManagedProductsByVendorResponseTypeDef definition
class DescribeManagedProductsByVendorResponseTypeDef(TypedDict):
ManagedProducts: List[ManagedProductDescriptorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GeoMatchStatementOutputTypeDef#
# GeoMatchStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GeoMatchStatementOutputTypeDef
def get_value() -> GeoMatchStatementOutputTypeDef:
return {
"CountryCodes": ...,
}
# GeoMatchStatementOutputTypeDef definition
class GeoMatchStatementOutputTypeDef(TypedDict):
CountryCodes: NotRequired[List[CountryCodeType]], # (1)
ForwardedIPConfig: NotRequired[ForwardedIPConfigTypeDef], # (2)GeoMatchStatementTypeDef#
# GeoMatchStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GeoMatchStatementTypeDef
def get_value() -> GeoMatchStatementTypeDef:
return {
"CountryCodes": ...,
}
# GeoMatchStatementTypeDef definition
class GeoMatchStatementTypeDef(TypedDict):
CountryCodes: NotRequired[Sequence[CountryCodeType]], # (1)
ForwardedIPConfig: NotRequired[ForwardedIPConfigTypeDef], # (2)GetIPSetResponseTypeDef#
# GetIPSetResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetIPSetResponseTypeDef
def get_value() -> GetIPSetResponseTypeDef:
return {
"IPSet": ...,
}
# GetIPSetResponseTypeDef definition
class GetIPSetResponseTypeDef(TypedDict):
IPSet: IPSetTypeDef, # (1)
LockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See IPSetTypeDef
- See ResponseMetadataTypeDef
GetRateBasedStatementManagedKeysResponseTypeDef#
# GetRateBasedStatementManagedKeysResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetRateBasedStatementManagedKeysResponseTypeDef
def get_value() -> GetRateBasedStatementManagedKeysResponseTypeDef:
return {
"ManagedKeysIPV4": ...,
}
# GetRateBasedStatementManagedKeysResponseTypeDef definition
class GetRateBasedStatementManagedKeysResponseTypeDef(TypedDict):
ManagedKeysIPV4: RateBasedStatementManagedKeysIPSetTypeDef, # (1)
ManagedKeysIPV6: RateBasedStatementManagedKeysIPSetTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See RateBasedStatementManagedKeysIPSetTypeDef
- See RateBasedStatementManagedKeysIPSetTypeDef
- See ResponseMetadataTypeDef
HTTPRequestTypeDef#
# HTTPRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import HTTPRequestTypeDef
def get_value() -> HTTPRequestTypeDef:
return {
"ClientIP": ...,
}
# HTTPRequestTypeDef definition
class HTTPRequestTypeDef(TypedDict):
ClientIP: NotRequired[str],
Country: NotRequired[str],
URI: NotRequired[str],
Method: NotRequired[str],
HTTPVersion: NotRequired[str],
Headers: NotRequired[List[HTTPHeaderTypeDef]], # (1)HeadersOutputTypeDef#
# HeadersOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import HeadersOutputTypeDef
def get_value() -> HeadersOutputTypeDef:
return {
"MatchPattern": ...,
}
# HeadersOutputTypeDef definition
class HeadersOutputTypeDef(TypedDict):
MatchPattern: HeaderMatchPatternOutputTypeDef, # (1)
MatchScope: MapMatchScopeType, # (2)
OversizeHandling: OversizeHandlingType, # (3)IPSetReferenceStatementTypeDef#
# IPSetReferenceStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import IPSetReferenceStatementTypeDef
def get_value() -> IPSetReferenceStatementTypeDef:
return {
"ARN": ...,
}
# IPSetReferenceStatementTypeDef definition
class IPSetReferenceStatementTypeDef(TypedDict):
ARN: str,
IPSetForwardedIPConfig: NotRequired[IPSetForwardedIPConfigTypeDef], # (1)JsonBodyOutputTypeDef#
# JsonBodyOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import JsonBodyOutputTypeDef
def get_value() -> JsonBodyOutputTypeDef:
return {
"MatchPattern": ...,
}
# JsonBodyOutputTypeDef definition
class JsonBodyOutputTypeDef(TypedDict):
MatchPattern: JsonMatchPatternOutputTypeDef, # (1)
MatchScope: JsonMatchScopeType, # (2)
InvalidFallbackBehavior: NotRequired[BodyParsingFallbackBehaviorType], # (3)
OversizeHandling: NotRequired[OversizeHandlingType], # (4)- See JsonMatchPatternOutputTypeDef
- See JsonMatchScopeType
- See BodyParsingFallbackBehaviorType
- See OversizeHandlingType
ListAvailableManagedRuleGroupVersionsResponseTypeDef#
# ListAvailableManagedRuleGroupVersionsResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListAvailableManagedRuleGroupVersionsResponseTypeDef
def get_value() -> ListAvailableManagedRuleGroupVersionsResponseTypeDef:
return {
"NextMarker": ...,
}
# ListAvailableManagedRuleGroupVersionsResponseTypeDef definition
class ListAvailableManagedRuleGroupVersionsResponseTypeDef(TypedDict):
NextMarker: str,
Versions: List[ManagedRuleGroupVersionTypeDef], # (1)
CurrentDefaultVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListAvailableManagedRuleGroupsResponseTypeDef#
# ListAvailableManagedRuleGroupsResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListAvailableManagedRuleGroupsResponseTypeDef
def get_value() -> ListAvailableManagedRuleGroupsResponseTypeDef:
return {
"NextMarker": ...,
}
# ListAvailableManagedRuleGroupsResponseTypeDef definition
class ListAvailableManagedRuleGroupsResponseTypeDef(TypedDict):
NextMarker: str,
ManagedRuleGroups: List[ManagedRuleGroupSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListManagedRuleSetsResponseTypeDef#
# ListManagedRuleSetsResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListManagedRuleSetsResponseTypeDef
def get_value() -> ListManagedRuleSetsResponseTypeDef:
return {
"NextMarker": ...,
}
# ListManagedRuleSetsResponseTypeDef definition
class ListManagedRuleSetsResponseTypeDef(TypedDict):
NextMarker: str,
ManagedRuleSets: List[ManagedRuleSetSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListMobileSdkReleasesResponseTypeDef#
# ListMobileSdkReleasesResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListMobileSdkReleasesResponseTypeDef
def get_value() -> ListMobileSdkReleasesResponseTypeDef:
return {
"ReleaseSummaries": ...,
}
# ListMobileSdkReleasesResponseTypeDef definition
class ListMobileSdkReleasesResponseTypeDef(TypedDict):
ReleaseSummaries: List[ReleaseSummaryTypeDef], # (1)
NextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)RequestInspectionTypeDef#
# RequestInspectionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RequestInspectionTypeDef
def get_value() -> RequestInspectionTypeDef:
return {
"PayloadType": ...,
}
# RequestInspectionTypeDef definition
class RequestInspectionTypeDef(TypedDict):
PayloadType: PayloadTypeType, # (1)
UsernameField: UsernameFieldTypeDef, # (2)
PasswordField: PasswordFieldTypeDef, # (3)- See PayloadTypeType
- See UsernameFieldTypeDef
- See PasswordFieldTypeDef
ManagedRuleSetTypeDef#
# ManagedRuleSetTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ManagedRuleSetTypeDef
def get_value() -> ManagedRuleSetTypeDef:
return {
"Name": ...,
}
# ManagedRuleSetTypeDef definition
class ManagedRuleSetTypeDef(TypedDict):
Name: str,
Id: str,
ARN: str,
Description: NotRequired[str],
PublishedVersions: NotRequired[Dict[str, ManagedRuleSetVersionTypeDef]], # (1)
RecommendedVersion: NotRequired[str],
LabelNamespace: NotRequired[str],RequestInspectionACFPOutputTypeDef#
# RequestInspectionACFPOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RequestInspectionACFPOutputTypeDef
def get_value() -> RequestInspectionACFPOutputTypeDef:
return {
"PayloadType": ...,
}
# RequestInspectionACFPOutputTypeDef definition
class RequestInspectionACFPOutputTypeDef(TypedDict):
PayloadType: PayloadTypeType, # (1)
UsernameField: NotRequired[UsernameFieldTypeDef], # (2)
PasswordField: NotRequired[PasswordFieldTypeDef], # (3)
EmailField: NotRequired[EmailFieldTypeDef], # (4)
PhoneNumberFields: NotRequired[List[PhoneNumberFieldTypeDef]], # (5)
AddressFields: NotRequired[List[AddressFieldTypeDef]], # (6)- See PayloadTypeType
- See UsernameFieldTypeDef
- See PasswordFieldTypeDef
- See EmailFieldTypeDef
- See PhoneNumberFieldTypeDef
- See AddressFieldTypeDef
RequestInspectionACFPTypeDef#
# RequestInspectionACFPTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RequestInspectionACFPTypeDef
def get_value() -> RequestInspectionACFPTypeDef:
return {
"PayloadType": ...,
}
# RequestInspectionACFPTypeDef definition
class RequestInspectionACFPTypeDef(TypedDict):
PayloadType: PayloadTypeType, # (1)
UsernameField: NotRequired[UsernameFieldTypeDef], # (2)
PasswordField: NotRequired[PasswordFieldTypeDef], # (3)
EmailField: NotRequired[EmailFieldTypeDef], # (4)
PhoneNumberFields: NotRequired[Sequence[PhoneNumberFieldTypeDef]], # (5)
AddressFields: NotRequired[Sequence[AddressFieldTypeDef]], # (6)- See PayloadTypeType
- See UsernameFieldTypeDef
- See PasswordFieldTypeDef
- See EmailFieldTypeDef
- See PhoneNumberFieldTypeDef
- See AddressFieldTypeDef
PutManagedRuleSetVersionsRequestTypeDef#
# PutManagedRuleSetVersionsRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import PutManagedRuleSetVersionsRequestTypeDef
def get_value() -> PutManagedRuleSetVersionsRequestTypeDef:
return {
"Name": ...,
}
# PutManagedRuleSetVersionsRequestTypeDef definition
class PutManagedRuleSetVersionsRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,
RecommendedVersion: NotRequired[str],
VersionsToPublish: NotRequired[Mapping[str, VersionToPublishTypeDef]], # (2)- See ScopeType
- See VersionToPublishTypeDef
ResponseInspectionOutputTypeDef#
# ResponseInspectionOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ResponseInspectionOutputTypeDef
def get_value() -> ResponseInspectionOutputTypeDef:
return {
"StatusCode": ...,
}
# ResponseInspectionOutputTypeDef definition
class ResponseInspectionOutputTypeDef(TypedDict):
StatusCode: NotRequired[ResponseInspectionStatusCodeOutputTypeDef], # (1)
Header: NotRequired[ResponseInspectionHeaderOutputTypeDef], # (2)
BodyContains: NotRequired[ResponseInspectionBodyContainsOutputTypeDef], # (3)
Json: NotRequired[ResponseInspectionJsonOutputTypeDef], # (4)- See ResponseInspectionStatusCodeOutputTypeDef
- See ResponseInspectionHeaderOutputTypeDef
- See ResponseInspectionBodyContainsOutputTypeDef
- See ResponseInspectionJsonOutputTypeDef
TimeWindowTypeDef#
# TimeWindowTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import TimeWindowTypeDef
def get_value() -> TimeWindowTypeDef:
return {
"StartTime": ...,
}
# TimeWindowTypeDef definition
class TimeWindowTypeDef(TypedDict):
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,UpdateManagedRuleSetVersionExpiryDateRequestTypeDef#
# UpdateManagedRuleSetVersionExpiryDateRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import UpdateManagedRuleSetVersionExpiryDateRequestTypeDef
def get_value() -> UpdateManagedRuleSetVersionExpiryDateRequestTypeDef:
return {
"Name": ...,
}
# UpdateManagedRuleSetVersionExpiryDateRequestTypeDef definition
class UpdateManagedRuleSetVersionExpiryDateRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,
VersionToExpire: str,
ExpiryTimestamp: TimestampTypeDef,- See ScopeType
RateBasedStatementCustomKeyOutputTypeDef#
# RateBasedStatementCustomKeyOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateBasedStatementCustomKeyOutputTypeDef
def get_value() -> RateBasedStatementCustomKeyOutputTypeDef:
return {
"Header": ...,
}
# RateBasedStatementCustomKeyOutputTypeDef definition
class RateBasedStatementCustomKeyOutputTypeDef(TypedDict):
Header: NotRequired[RateLimitHeaderOutputTypeDef], # (1)
Cookie: NotRequired[RateLimitCookieOutputTypeDef], # (2)
QueryArgument: NotRequired[RateLimitQueryArgumentOutputTypeDef], # (3)
QueryString: NotRequired[RateLimitQueryStringOutputTypeDef], # (4)
HTTPMethod: NotRequired[Dict[str, Any]],
ForwardedIP: NotRequired[Dict[str, Any]],
IP: NotRequired[Dict[str, Any]],
LabelNamespace: NotRequired[RateLimitLabelNamespaceTypeDef], # (5)
UriPath: NotRequired[RateLimitUriPathOutputTypeDef], # (6)- See RateLimitHeaderOutputTypeDef
- See RateLimitCookieOutputTypeDef
- See RateLimitQueryArgumentOutputTypeDef
- See RateLimitQueryStringOutputTypeDef
- See RateLimitLabelNamespaceTypeDef
- See RateLimitUriPathOutputTypeDef
FilterOutputTypeDef#
# FilterOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import FilterOutputTypeDef
def get_value() -> FilterOutputTypeDef:
return {
"Behavior": ...,
}
# FilterOutputTypeDef definition
class FilterOutputTypeDef(TypedDict):
Behavior: FilterBehaviorType, # (1)
Requirement: FilterRequirementType, # (2)
Conditions: List[ConditionTypeDef], # (3)- See FilterBehaviorType
- See FilterRequirementType
- See ConditionTypeDef
FilterTypeDef#
# FilterTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import FilterTypeDef
def get_value() -> FilterTypeDef:
return {
"Behavior": ...,
}
# FilterTypeDef definition
class FilterTypeDef(TypedDict):
Behavior: FilterBehaviorType, # (1)
Requirement: FilterRequirementType, # (2)
Conditions: Sequence[ConditionTypeDef], # (3)- See FilterBehaviorType
- See FilterRequirementType
- See ConditionTypeDef
CookiesTypeDef#
# CookiesTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CookiesTypeDef
def get_value() -> CookiesTypeDef:
return {
"MatchPattern": ...,
}
# CookiesTypeDef definition
class CookiesTypeDef(TypedDict):
MatchPattern: CookieMatchPatternUnionTypeDef, # (1)
MatchScope: MapMatchScopeType, # (2)
OversizeHandling: OversizeHandlingType, # (3)- See CookieMatchPatternTypeDef CookieMatchPatternOutputTypeDef
- See MapMatchScopeType
- See OversizeHandlingType
GetMobileSdkReleaseResponseTypeDef#
# GetMobileSdkReleaseResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetMobileSdkReleaseResponseTypeDef
def get_value() -> GetMobileSdkReleaseResponseTypeDef:
return {
"MobileSdkRelease": ...,
}
# GetMobileSdkReleaseResponseTypeDef definition
class GetMobileSdkReleaseResponseTypeDef(TypedDict):
MobileSdkRelease: MobileSdkReleaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"NextMarker": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
NextMarker: str,
TagInfoForResource: TagInfoForResourceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetRegexPatternSetResponseTypeDef#
# GetRegexPatternSetResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetRegexPatternSetResponseTypeDef
def get_value() -> GetRegexPatternSetResponseTypeDef:
return {
"RegexPatternSet": ...,
}
# GetRegexPatternSetResponseTypeDef definition
class GetRegexPatternSetResponseTypeDef(TypedDict):
RegexPatternSet: RegexPatternSetTypeDef, # (1)
LockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)AllowActionOutputTypeDef#
# AllowActionOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AllowActionOutputTypeDef
def get_value() -> AllowActionOutputTypeDef:
return {
"CustomRequestHandling": ...,
}
# AllowActionOutputTypeDef definition
class AllowActionOutputTypeDef(TypedDict):
CustomRequestHandling: NotRequired[CustomRequestHandlingOutputTypeDef], # (1)CaptchaActionOutputTypeDef#
# CaptchaActionOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CaptchaActionOutputTypeDef
def get_value() -> CaptchaActionOutputTypeDef:
return {
"CustomRequestHandling": ...,
}
# CaptchaActionOutputTypeDef definition
class CaptchaActionOutputTypeDef(TypedDict):
CustomRequestHandling: NotRequired[CustomRequestHandlingOutputTypeDef], # (1)ChallengeActionOutputTypeDef#
# ChallengeActionOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ChallengeActionOutputTypeDef
def get_value() -> ChallengeActionOutputTypeDef:
return {
"CustomRequestHandling": ...,
}
# ChallengeActionOutputTypeDef definition
class ChallengeActionOutputTypeDef(TypedDict):
CustomRequestHandling: NotRequired[CustomRequestHandlingOutputTypeDef], # (1)CountActionOutputTypeDef#
# CountActionOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CountActionOutputTypeDef
def get_value() -> CountActionOutputTypeDef:
return {
"CustomRequestHandling": ...,
}
# CountActionOutputTypeDef definition
class CountActionOutputTypeDef(TypedDict):
CustomRequestHandling: NotRequired[CustomRequestHandlingOutputTypeDef], # (1)BlockActionOutputTypeDef#
# BlockActionOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import BlockActionOutputTypeDef
def get_value() -> BlockActionOutputTypeDef:
return {
"CustomResponse": ...,
}
# BlockActionOutputTypeDef definition
class BlockActionOutputTypeDef(TypedDict):
CustomResponse: NotRequired[CustomResponseOutputTypeDef], # (1)DataProtectionConfigOutputTypeDef#
# DataProtectionConfigOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DataProtectionConfigOutputTypeDef
def get_value() -> DataProtectionConfigOutputTypeDef:
return {
"DataProtections": ...,
}
# DataProtectionConfigOutputTypeDef definition
class DataProtectionConfigOutputTypeDef(TypedDict):
DataProtections: List[DataProtectionOutputTypeDef], # (1)DataProtectionConfigTypeDef#
# DataProtectionConfigTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DataProtectionConfigTypeDef
def get_value() -> DataProtectionConfigTypeDef:
return {
"DataProtections": ...,
}
# DataProtectionConfigTypeDef definition
class DataProtectionConfigTypeDef(TypedDict):
DataProtections: Sequence[DataProtectionTypeDef], # (1)SampledHTTPRequestTypeDef#
# SampledHTTPRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import SampledHTTPRequestTypeDef
def get_value() -> SampledHTTPRequestTypeDef:
return {
"Request": ...,
}
# SampledHTTPRequestTypeDef definition
class SampledHTTPRequestTypeDef(TypedDict):
Request: HTTPRequestTypeDef, # (1)
Weight: int,
Timestamp: NotRequired[datetime],
Action: NotRequired[str],
RuleNameWithinRuleGroup: NotRequired[str],
RequestHeadersInserted: NotRequired[List[HTTPHeaderTypeDef]], # (2)
ResponseCodeSent: NotRequired[int],
Labels: NotRequired[List[LabelTypeDef]], # (3)
CaptchaResponse: NotRequired[CaptchaResponseTypeDef], # (4)
ChallengeResponse: NotRequired[ChallengeResponseTypeDef], # (5)
OverriddenAction: NotRequired[str],- See HTTPRequestTypeDef
- See HTTPHeaderTypeDef
- See LabelTypeDef
- See CaptchaResponseTypeDef
- See ChallengeResponseTypeDef
HeadersTypeDef#
# HeadersTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import HeadersTypeDef
def get_value() -> HeadersTypeDef:
return {
"MatchPattern": ...,
}
# HeadersTypeDef definition
class HeadersTypeDef(TypedDict):
MatchPattern: HeaderMatchPatternUnionTypeDef, # (1)
MatchScope: MapMatchScopeType, # (2)
OversizeHandling: OversizeHandlingType, # (3)- See HeaderMatchPatternTypeDef HeaderMatchPatternOutputTypeDef
- See MapMatchScopeType
- See OversizeHandlingType
FieldToMatchOutputTypeDef#
# FieldToMatchOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import FieldToMatchOutputTypeDef
def get_value() -> FieldToMatchOutputTypeDef:
return {
"SingleHeader": ...,
}
# FieldToMatchOutputTypeDef definition
class FieldToMatchOutputTypeDef(TypedDict):
SingleHeader: NotRequired[SingleHeaderTypeDef], # (1)
SingleQueryArgument: NotRequired[SingleQueryArgumentTypeDef], # (2)
AllQueryArguments: NotRequired[Dict[str, Any]],
UriPath: NotRequired[Dict[str, Any]],
QueryString: NotRequired[Dict[str, Any]],
Body: NotRequired[BodyTypeDef], # (3)
Method: NotRequired[Dict[str, Any]],
JsonBody: NotRequired[JsonBodyOutputTypeDef], # (4)
Headers: NotRequired[HeadersOutputTypeDef], # (5)
Cookies: NotRequired[CookiesOutputTypeDef], # (6)
HeaderOrder: NotRequired[HeaderOrderTypeDef], # (7)
JA3Fingerprint: NotRequired[JA3FingerprintTypeDef], # (8)- See SingleHeaderTypeDef
- See SingleQueryArgumentTypeDef
- See BodyTypeDef
- See JsonBodyOutputTypeDef
- See HeadersOutputTypeDef
- See CookiesOutputTypeDef
- See HeaderOrderTypeDef
- See JA3FingerprintTypeDef
JsonBodyTypeDef#
# JsonBodyTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import JsonBodyTypeDef
def get_value() -> JsonBodyTypeDef:
return {
"MatchPattern": ...,
}
# JsonBodyTypeDef definition
class JsonBodyTypeDef(TypedDict):
MatchPattern: JsonMatchPatternUnionTypeDef, # (1)
MatchScope: JsonMatchScopeType, # (2)
InvalidFallbackBehavior: NotRequired[BodyParsingFallbackBehaviorType], # (3)
OversizeHandling: NotRequired[OversizeHandlingType], # (4)- See JsonMatchPatternTypeDef JsonMatchPatternOutputTypeDef
- See JsonMatchScopeType
- See BodyParsingFallbackBehaviorType
- See OversizeHandlingType
GetManagedRuleSetResponseTypeDef#
# GetManagedRuleSetResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetManagedRuleSetResponseTypeDef
def get_value() -> GetManagedRuleSetResponseTypeDef:
return {
"ManagedRuleSet": ...,
}
# GetManagedRuleSetResponseTypeDef definition
class GetManagedRuleSetResponseTypeDef(TypedDict):
ManagedRuleSet: ManagedRuleSetTypeDef, # (1)
LockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)AWSManagedRulesACFPRuleSetOutputTypeDef#
# AWSManagedRulesACFPRuleSetOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AWSManagedRulesACFPRuleSetOutputTypeDef
def get_value() -> AWSManagedRulesACFPRuleSetOutputTypeDef:
return {
"CreationPath": ...,
}
# AWSManagedRulesACFPRuleSetOutputTypeDef definition
class AWSManagedRulesACFPRuleSetOutputTypeDef(TypedDict):
CreationPath: str,
RegistrationPagePath: str,
RequestInspection: RequestInspectionACFPOutputTypeDef, # (1)
ResponseInspection: NotRequired[ResponseInspectionOutputTypeDef], # (2)
EnableRegexInPath: NotRequired[bool],AWSManagedRulesATPRuleSetOutputTypeDef#
# AWSManagedRulesATPRuleSetOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AWSManagedRulesATPRuleSetOutputTypeDef
def get_value() -> AWSManagedRulesATPRuleSetOutputTypeDef:
return {
"LoginPath": ...,
}
# AWSManagedRulesATPRuleSetOutputTypeDef definition
class AWSManagedRulesATPRuleSetOutputTypeDef(TypedDict):
LoginPath: str,
RequestInspection: NotRequired[RequestInspectionTypeDef], # (1)
ResponseInspection: NotRequired[ResponseInspectionOutputTypeDef], # (2)
EnableRegexInPath: NotRequired[bool],ResponseInspectionTypeDef#
# ResponseInspectionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ResponseInspectionTypeDef
def get_value() -> ResponseInspectionTypeDef:
return {
"StatusCode": ...,
}
# ResponseInspectionTypeDef definition
class ResponseInspectionTypeDef(TypedDict):
StatusCode: NotRequired[ResponseInspectionStatusCodeUnionTypeDef], # (1)
Header: NotRequired[ResponseInspectionHeaderUnionTypeDef], # (2)
BodyContains: NotRequired[ResponseInspectionBodyContainsUnionTypeDef], # (3)
Json: NotRequired[ResponseInspectionJsonUnionTypeDef], # (4)- See ResponseInspectionStatusCodeTypeDef ResponseInspectionStatusCodeOutputTypeDef
- See ResponseInspectionHeaderTypeDef ResponseInspectionHeaderOutputTypeDef
- See ResponseInspectionBodyContainsTypeDef ResponseInspectionBodyContainsOutputTypeDef
- See ResponseInspectionJsonTypeDef ResponseInspectionJsonOutputTypeDef
RateBasedStatementOutputTypeDef#
# RateBasedStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateBasedStatementOutputTypeDef
def get_value() -> RateBasedStatementOutputTypeDef:
return {
"Limit": ...,
}
# RateBasedStatementOutputTypeDef definition
class RateBasedStatementOutputTypeDef(TypedDict):
Limit: int,
AggregateKeyType: RateBasedStatementAggregateKeyTypeType, # (1)
EvaluationWindowSec: NotRequired[int],
ScopeDownStatement: NotRequired[Dict[str, Any]],
ForwardedIPConfig: NotRequired[ForwardedIPConfigTypeDef], # (2)
CustomKeys: NotRequired[List[RateBasedStatementCustomKeyOutputTypeDef]], # (3)- See RateBasedStatementAggregateKeyTypeType
- See ForwardedIPConfigTypeDef
- See RateBasedStatementCustomKeyOutputTypeDef
RateBasedStatementCustomKeyTypeDef#
# RateBasedStatementCustomKeyTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateBasedStatementCustomKeyTypeDef
def get_value() -> RateBasedStatementCustomKeyTypeDef:
return {
"Header": ...,
}
# RateBasedStatementCustomKeyTypeDef definition
class RateBasedStatementCustomKeyTypeDef(TypedDict):
Header: NotRequired[RateLimitHeaderUnionTypeDef], # (1)
Cookie: NotRequired[RateLimitCookieUnionTypeDef], # (2)
QueryArgument: NotRequired[RateLimitQueryArgumentUnionTypeDef], # (3)
QueryString: NotRequired[RateLimitQueryStringUnionTypeDef], # (4)
HTTPMethod: NotRequired[Mapping[str, Any]],
ForwardedIP: NotRequired[Mapping[str, Any]],
IP: NotRequired[Mapping[str, Any]],
LabelNamespace: NotRequired[RateLimitLabelNamespaceTypeDef], # (5)
UriPath: NotRequired[RateLimitUriPathUnionTypeDef], # (6)- See RateLimitHeaderTypeDef RateLimitHeaderOutputTypeDef
- See RateLimitCookieTypeDef RateLimitCookieOutputTypeDef
- See RateLimitQueryArgumentTypeDef RateLimitQueryArgumentOutputTypeDef
- See RateLimitQueryStringTypeDef RateLimitQueryStringOutputTypeDef
- See RateLimitLabelNamespaceTypeDef
- See RateLimitUriPathTypeDef RateLimitUriPathOutputTypeDef
LoggingFilterOutputTypeDef#
# LoggingFilterOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import LoggingFilterOutputTypeDef
def get_value() -> LoggingFilterOutputTypeDef:
return {
"Filters": ...,
}
# LoggingFilterOutputTypeDef definition
class LoggingFilterOutputTypeDef(TypedDict):
Filters: List[FilterOutputTypeDef], # (1)
DefaultBehavior: FilterBehaviorType, # (2)LoggingFilterTypeDef#
# LoggingFilterTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import LoggingFilterTypeDef
def get_value() -> LoggingFilterTypeDef:
return {
"Filters": ...,
}
# LoggingFilterTypeDef definition
class LoggingFilterTypeDef(TypedDict):
Filters: Sequence[FilterTypeDef], # (1)
DefaultBehavior: FilterBehaviorType, # (2)- See FilterTypeDef
- See FilterBehaviorType
OverrideActionOutputTypeDef#
# OverrideActionOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import OverrideActionOutputTypeDef
def get_value() -> OverrideActionOutputTypeDef:
return {
"Count": ...,
}
# OverrideActionOutputTypeDef definition
class OverrideActionOutputTypeDef(TypedDict):
Count: NotRequired[CountActionOutputTypeDef], # (1)
None: NotRequired[Dict[str, Any]],AllowActionTypeDef#
# AllowActionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AllowActionTypeDef
def get_value() -> AllowActionTypeDef:
return {
"CustomRequestHandling": ...,
}
# AllowActionTypeDef definition
class AllowActionTypeDef(TypedDict):
CustomRequestHandling: NotRequired[CustomRequestHandlingUnionTypeDef], # (1)CaptchaActionTypeDef#
# CaptchaActionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CaptchaActionTypeDef
def get_value() -> CaptchaActionTypeDef:
return {
"CustomRequestHandling": ...,
}
# CaptchaActionTypeDef definition
class CaptchaActionTypeDef(TypedDict):
CustomRequestHandling: NotRequired[CustomRequestHandlingUnionTypeDef], # (1)ChallengeActionTypeDef#
# ChallengeActionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ChallengeActionTypeDef
def get_value() -> ChallengeActionTypeDef:
return {
"CustomRequestHandling": ...,
}
# ChallengeActionTypeDef definition
class ChallengeActionTypeDef(TypedDict):
CustomRequestHandling: NotRequired[CustomRequestHandlingUnionTypeDef], # (1)CountActionTypeDef#
# CountActionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CountActionTypeDef
def get_value() -> CountActionTypeDef:
return {
"CustomRequestHandling": ...,
}
# CountActionTypeDef definition
class CountActionTypeDef(TypedDict):
CustomRequestHandling: NotRequired[CustomRequestHandlingUnionTypeDef], # (1)DefaultActionOutputTypeDef#
# DefaultActionOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DefaultActionOutputTypeDef
def get_value() -> DefaultActionOutputTypeDef:
return {
"Block": ...,
}
# DefaultActionOutputTypeDef definition
class DefaultActionOutputTypeDef(TypedDict):
Block: NotRequired[BlockActionOutputTypeDef], # (1)
Allow: NotRequired[AllowActionOutputTypeDef], # (2)RuleActionOutputTypeDef#
# RuleActionOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RuleActionOutputTypeDef
def get_value() -> RuleActionOutputTypeDef:
return {
"Block": ...,
}
# RuleActionOutputTypeDef definition
class RuleActionOutputTypeDef(TypedDict):
Block: NotRequired[BlockActionOutputTypeDef], # (1)
Allow: NotRequired[AllowActionOutputTypeDef], # (2)
Count: NotRequired[CountActionOutputTypeDef], # (3)
Captcha: NotRequired[CaptchaActionOutputTypeDef], # (4)
Challenge: NotRequired[ChallengeActionOutputTypeDef], # (5)- See BlockActionOutputTypeDef
- See AllowActionOutputTypeDef
- See CountActionOutputTypeDef
- See CaptchaActionOutputTypeDef
- See ChallengeActionOutputTypeDef
BlockActionTypeDef#
# BlockActionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import BlockActionTypeDef
def get_value() -> BlockActionTypeDef:
return {
"CustomResponse": ...,
}
# BlockActionTypeDef definition
class BlockActionTypeDef(TypedDict):
CustomResponse: NotRequired[CustomResponseUnionTypeDef], # (1)GetSampledRequestsResponseTypeDef#
# GetSampledRequestsResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetSampledRequestsResponseTypeDef
def get_value() -> GetSampledRequestsResponseTypeDef:
return {
"SampledRequests": ...,
}
# GetSampledRequestsResponseTypeDef definition
class GetSampledRequestsResponseTypeDef(TypedDict):
SampledRequests: List[SampledHTTPRequestTypeDef], # (1)
PopulationSize: int,
TimeWindow: TimeWindowOutputTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)ByteMatchStatementOutputTypeDef#
# ByteMatchStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ByteMatchStatementOutputTypeDef
def get_value() -> ByteMatchStatementOutputTypeDef:
return {
"SearchString": ...,
}
# ByteMatchStatementOutputTypeDef definition
class ByteMatchStatementOutputTypeDef(TypedDict):
SearchString: bytes,
FieldToMatch: FieldToMatchOutputTypeDef, # (1)
TextTransformations: List[TextTransformationTypeDef], # (2)
PositionalConstraint: PositionalConstraintType, # (3)RegexMatchStatementOutputTypeDef#
# RegexMatchStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RegexMatchStatementOutputTypeDef
def get_value() -> RegexMatchStatementOutputTypeDef:
return {
"RegexString": ...,
}
# RegexMatchStatementOutputTypeDef definition
class RegexMatchStatementOutputTypeDef(TypedDict):
RegexString: str,
FieldToMatch: FieldToMatchOutputTypeDef, # (1)
TextTransformations: List[TextTransformationTypeDef], # (2)RegexPatternSetReferenceStatementOutputTypeDef#
# RegexPatternSetReferenceStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RegexPatternSetReferenceStatementOutputTypeDef
def get_value() -> RegexPatternSetReferenceStatementOutputTypeDef:
return {
"ARN": ...,
}
# RegexPatternSetReferenceStatementOutputTypeDef definition
class RegexPatternSetReferenceStatementOutputTypeDef(TypedDict):
ARN: str,
FieldToMatch: FieldToMatchOutputTypeDef, # (1)
TextTransformations: List[TextTransformationTypeDef], # (2)SizeConstraintStatementOutputTypeDef#
# SizeConstraintStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import SizeConstraintStatementOutputTypeDef
def get_value() -> SizeConstraintStatementOutputTypeDef:
return {
"FieldToMatch": ...,
}
# SizeConstraintStatementOutputTypeDef definition
class SizeConstraintStatementOutputTypeDef(TypedDict):
FieldToMatch: FieldToMatchOutputTypeDef, # (1)
ComparisonOperator: ComparisonOperatorType, # (2)
Size: int,
TextTransformations: List[TextTransformationTypeDef], # (3)SqliMatchStatementOutputTypeDef#
# SqliMatchStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import SqliMatchStatementOutputTypeDef
def get_value() -> SqliMatchStatementOutputTypeDef:
return {
"FieldToMatch": ...,
}
# SqliMatchStatementOutputTypeDef definition
class SqliMatchStatementOutputTypeDef(TypedDict):
FieldToMatch: FieldToMatchOutputTypeDef, # (1)
TextTransformations: List[TextTransformationTypeDef], # (2)
SensitivityLevel: NotRequired[SensitivityLevelType], # (3)XssMatchStatementOutputTypeDef#
# XssMatchStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import XssMatchStatementOutputTypeDef
def get_value() -> XssMatchStatementOutputTypeDef:
return {
"FieldToMatch": ...,
}
# XssMatchStatementOutputTypeDef definition
class XssMatchStatementOutputTypeDef(TypedDict):
FieldToMatch: FieldToMatchOutputTypeDef, # (1)
TextTransformations: List[TextTransformationTypeDef], # (2)ManagedRuleGroupConfigOutputTypeDef#
# ManagedRuleGroupConfigOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ManagedRuleGroupConfigOutputTypeDef
def get_value() -> ManagedRuleGroupConfigOutputTypeDef:
return {
"LoginPath": ...,
}
# ManagedRuleGroupConfigOutputTypeDef definition
class ManagedRuleGroupConfigOutputTypeDef(TypedDict):
LoginPath: NotRequired[str],
PayloadType: NotRequired[PayloadTypeType], # (1)
UsernameField: NotRequired[UsernameFieldTypeDef], # (2)
PasswordField: NotRequired[PasswordFieldTypeDef], # (3)
AWSManagedRulesBotControlRuleSet: NotRequired[AWSManagedRulesBotControlRuleSetTypeDef], # (4)
AWSManagedRulesATPRuleSet: NotRequired[AWSManagedRulesATPRuleSetOutputTypeDef], # (5)
AWSManagedRulesACFPRuleSet: NotRequired[AWSManagedRulesACFPRuleSetOutputTypeDef], # (6)- See PayloadTypeType
- See UsernameFieldTypeDef
- See PasswordFieldTypeDef
- See AWSManagedRulesBotControlRuleSetTypeDef
- See AWSManagedRulesATPRuleSetOutputTypeDef
- See AWSManagedRulesACFPRuleSetOutputTypeDef
GetSampledRequestsRequestTypeDef#
# GetSampledRequestsRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetSampledRequestsRequestTypeDef
def get_value() -> GetSampledRequestsRequestTypeDef:
return {
"WebAclArn": ...,
}
# GetSampledRequestsRequestTypeDef definition
class GetSampledRequestsRequestTypeDef(TypedDict):
WebAclArn: str,
RuleMetricName: str,
Scope: ScopeType, # (1)
TimeWindow: TimeWindowUnionTypeDef, # (2)
MaxItems: int,LoggingConfigurationOutputTypeDef#
# LoggingConfigurationOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import LoggingConfigurationOutputTypeDef
def get_value() -> LoggingConfigurationOutputTypeDef:
return {
"ResourceArn": ...,
}
# LoggingConfigurationOutputTypeDef definition
class LoggingConfigurationOutputTypeDef(TypedDict):
ResourceArn: str,
LogDestinationConfigs: List[str],
RedactedFields: NotRequired[List[FieldToMatchOutputTypeDef]], # (1)
ManagedByFirewallManager: NotRequired[bool],
LoggingFilter: NotRequired[LoggingFilterOutputTypeDef], # (2)
LogType: NotRequired[LogTypeType], # (3)
LogScope: NotRequired[LogScopeType], # (4)- See FieldToMatchOutputTypeDef
- See LoggingFilterOutputTypeDef
- See LogTypeType
- See LogScopeType
RuleActionOverrideOutputTypeDef#
# RuleActionOverrideOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RuleActionOverrideOutputTypeDef
def get_value() -> RuleActionOverrideOutputTypeDef:
return {
"Name": ...,
}
# RuleActionOverrideOutputTypeDef definition
class RuleActionOverrideOutputTypeDef(TypedDict):
Name: str,
ActionToUse: RuleActionOutputTypeDef, # (1)RuleSummaryTypeDef#
# RuleSummaryTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RuleSummaryTypeDef
def get_value() -> RuleSummaryTypeDef:
return {
"Name": ...,
}
# RuleSummaryTypeDef definition
class RuleSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Action: NotRequired[RuleActionOutputTypeDef], # (1)DefaultActionTypeDef#
# DefaultActionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DefaultActionTypeDef
def get_value() -> DefaultActionTypeDef:
return {
"Block": ...,
}
# DefaultActionTypeDef definition
class DefaultActionTypeDef(TypedDict):
Block: NotRequired[BlockActionTypeDef], # (1)
Allow: NotRequired[AllowActionTypeDef], # (2)- See BlockActionTypeDef
- See AllowActionTypeDef
FieldToMatchTypeDef#
# FieldToMatchTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import FieldToMatchTypeDef
def get_value() -> FieldToMatchTypeDef:
return {
"SingleHeader": ...,
}
# FieldToMatchTypeDef definition
class FieldToMatchTypeDef(TypedDict):
SingleHeader: NotRequired[SingleHeaderTypeDef], # (1)
SingleQueryArgument: NotRequired[SingleQueryArgumentTypeDef], # (2)
AllQueryArguments: NotRequired[Mapping[str, Any]],
UriPath: NotRequired[Mapping[str, Any]],
QueryString: NotRequired[Mapping[str, Any]],
Body: NotRequired[BodyTypeDef], # (3)
Method: NotRequired[Mapping[str, Any]],
JsonBody: NotRequired[JsonBodyUnionTypeDef], # (4)
Headers: NotRequired[HeadersUnionTypeDef], # (5)
Cookies: NotRequired[CookiesUnionTypeDef], # (6)
HeaderOrder: NotRequired[HeaderOrderTypeDef], # (7)
JA3Fingerprint: NotRequired[JA3FingerprintTypeDef], # (8)- See SingleHeaderTypeDef
- See SingleQueryArgumentTypeDef
- See BodyTypeDef
- See JsonBodyTypeDef JsonBodyOutputTypeDef
- See HeadersTypeDef HeadersOutputTypeDef
- See CookiesTypeDef CookiesOutputTypeDef
- See HeaderOrderTypeDef
- See JA3FingerprintTypeDef
AWSManagedRulesACFPRuleSetTypeDef#
# AWSManagedRulesACFPRuleSetTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AWSManagedRulesACFPRuleSetTypeDef
def get_value() -> AWSManagedRulesACFPRuleSetTypeDef:
return {
"CreationPath": ...,
}
# AWSManagedRulesACFPRuleSetTypeDef definition
class AWSManagedRulesACFPRuleSetTypeDef(TypedDict):
CreationPath: str,
RegistrationPagePath: str,
RequestInspection: RequestInspectionACFPUnionTypeDef, # (1)
ResponseInspection: NotRequired[ResponseInspectionUnionTypeDef], # (2)
EnableRegexInPath: NotRequired[bool],- See RequestInspectionACFPTypeDef RequestInspectionACFPOutputTypeDef
- See ResponseInspectionTypeDef ResponseInspectionOutputTypeDef
AWSManagedRulesATPRuleSetTypeDef#
# AWSManagedRulesATPRuleSetTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import AWSManagedRulesATPRuleSetTypeDef
def get_value() -> AWSManagedRulesATPRuleSetTypeDef:
return {
"LoginPath": ...,
}
# AWSManagedRulesATPRuleSetTypeDef definition
class AWSManagedRulesATPRuleSetTypeDef(TypedDict):
LoginPath: str,
RequestInspection: NotRequired[RequestInspectionTypeDef], # (1)
ResponseInspection: NotRequired[ResponseInspectionUnionTypeDef], # (2)
EnableRegexInPath: NotRequired[bool],RateBasedStatementTypeDef#
# RateBasedStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RateBasedStatementTypeDef
def get_value() -> RateBasedStatementTypeDef:
return {
"Limit": ...,
}
# RateBasedStatementTypeDef definition
class RateBasedStatementTypeDef(TypedDict):
Limit: int,
AggregateKeyType: RateBasedStatementAggregateKeyTypeType, # (1)
EvaluationWindowSec: NotRequired[int],
ScopeDownStatement: NotRequired[Mapping[str, Any]],
ForwardedIPConfig: NotRequired[ForwardedIPConfigTypeDef], # (2)
CustomKeys: NotRequired[Sequence[RateBasedStatementCustomKeyUnionTypeDef]], # (3)- See RateBasedStatementAggregateKeyTypeType
- See ForwardedIPConfigTypeDef
- See RateBasedStatementCustomKeyTypeDef RateBasedStatementCustomKeyOutputTypeDef
GetLoggingConfigurationResponseTypeDef#
# GetLoggingConfigurationResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetLoggingConfigurationResponseTypeDef
def get_value() -> GetLoggingConfigurationResponseTypeDef:
return {
"LoggingConfiguration": ...,
}
# GetLoggingConfigurationResponseTypeDef definition
class GetLoggingConfigurationResponseTypeDef(TypedDict):
LoggingConfiguration: LoggingConfigurationOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListLoggingConfigurationsResponseTypeDef#
# ListLoggingConfigurationsResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ListLoggingConfigurationsResponseTypeDef
def get_value() -> ListLoggingConfigurationsResponseTypeDef:
return {
"LoggingConfigurations": ...,
}
# ListLoggingConfigurationsResponseTypeDef definition
class ListLoggingConfigurationsResponseTypeDef(TypedDict):
LoggingConfigurations: List[LoggingConfigurationOutputTypeDef], # (1)
NextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)PutLoggingConfigurationResponseTypeDef#
# PutLoggingConfigurationResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import PutLoggingConfigurationResponseTypeDef
def get_value() -> PutLoggingConfigurationResponseTypeDef:
return {
"LoggingConfiguration": ...,
}
# PutLoggingConfigurationResponseTypeDef definition
class PutLoggingConfigurationResponseTypeDef(TypedDict):
LoggingConfiguration: LoggingConfigurationOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)OverrideActionTypeDef#
# OverrideActionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import OverrideActionTypeDef
def get_value() -> OverrideActionTypeDef:
return {
"Count": ...,
}
# OverrideActionTypeDef definition
class OverrideActionTypeDef(TypedDict):
Count: NotRequired[CountActionUnionTypeDef], # (1)
None: NotRequired[Mapping[str, Any]],ManagedRuleGroupStatementOutputTypeDef#
# ManagedRuleGroupStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ManagedRuleGroupStatementOutputTypeDef
def get_value() -> ManagedRuleGroupStatementOutputTypeDef:
return {
"VendorName": ...,
}
# ManagedRuleGroupStatementOutputTypeDef definition
class ManagedRuleGroupStatementOutputTypeDef(TypedDict):
VendorName: str,
Name: str,
Version: NotRequired[str],
ExcludedRules: NotRequired[List[ExcludedRuleTypeDef]], # (1)
ScopeDownStatement: NotRequired[Dict[str, Any]],
ManagedRuleGroupConfigs: NotRequired[List[ManagedRuleGroupConfigOutputTypeDef]], # (2)
RuleActionOverrides: NotRequired[List[RuleActionOverrideOutputTypeDef]], # (3)RuleGroupReferenceStatementOutputTypeDef#
# RuleGroupReferenceStatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RuleGroupReferenceStatementOutputTypeDef
def get_value() -> RuleGroupReferenceStatementOutputTypeDef:
return {
"ARN": ...,
}
# RuleGroupReferenceStatementOutputTypeDef definition
class RuleGroupReferenceStatementOutputTypeDef(TypedDict):
ARN: str,
ExcludedRules: NotRequired[List[ExcludedRuleTypeDef]], # (1)
RuleActionOverrides: NotRequired[List[RuleActionOverrideOutputTypeDef]], # (2)DescribeManagedRuleGroupResponseTypeDef#
# DescribeManagedRuleGroupResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import DescribeManagedRuleGroupResponseTypeDef
def get_value() -> DescribeManagedRuleGroupResponseTypeDef:
return {
"VersionName": ...,
}
# DescribeManagedRuleGroupResponseTypeDef definition
class DescribeManagedRuleGroupResponseTypeDef(TypedDict):
VersionName: str,
SnsTopicArn: str,
Capacity: int,
Rules: List[RuleSummaryTypeDef], # (1)
LabelNamespace: str,
AvailableLabels: List[LabelSummaryTypeDef], # (2)
ConsumedLabels: List[LabelSummaryTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (4)RuleActionTypeDef#
# RuleActionTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RuleActionTypeDef
def get_value() -> RuleActionTypeDef:
return {
"Block": ...,
}
# RuleActionTypeDef definition
class RuleActionTypeDef(TypedDict):
Block: NotRequired[BlockActionUnionTypeDef], # (1)
Allow: NotRequired[AllowActionUnionTypeDef], # (2)
Count: NotRequired[CountActionUnionTypeDef], # (3)
Captcha: NotRequired[CaptchaActionUnionTypeDef], # (4)
Challenge: NotRequired[ChallengeActionUnionTypeDef], # (5)- See BlockActionTypeDef BlockActionOutputTypeDef
- See AllowActionTypeDef AllowActionOutputTypeDef
- See CountActionTypeDef CountActionOutputTypeDef
- See CaptchaActionTypeDef CaptchaActionOutputTypeDef
- See ChallengeActionTypeDef ChallengeActionOutputTypeDef
LoggingConfigurationTypeDef#
# LoggingConfigurationTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import LoggingConfigurationTypeDef
def get_value() -> LoggingConfigurationTypeDef:
return {
"ResourceArn": ...,
}
# LoggingConfigurationTypeDef definition
class LoggingConfigurationTypeDef(TypedDict):
ResourceArn: str,
LogDestinationConfigs: Sequence[str],
RedactedFields: NotRequired[Sequence[FieldToMatchTypeDef]], # (1)
ManagedByFirewallManager: NotRequired[bool],
LoggingFilter: NotRequired[LoggingFilterTypeDef], # (2)
LogType: NotRequired[LogTypeType], # (3)
LogScope: NotRequired[LogScopeType], # (4)- See FieldToMatchTypeDef
- See LoggingFilterTypeDef
- See LogTypeType
- See LogScopeType
FirewallManagerStatementTypeDef#
# FirewallManagerStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import FirewallManagerStatementTypeDef
def get_value() -> FirewallManagerStatementTypeDef:
return {
"ManagedRuleGroupStatement": ...,
}
# FirewallManagerStatementTypeDef definition
class FirewallManagerStatementTypeDef(TypedDict):
ManagedRuleGroupStatement: NotRequired[ManagedRuleGroupStatementOutputTypeDef], # (1)
RuleGroupReferenceStatement: NotRequired[RuleGroupReferenceStatementOutputTypeDef], # (2)StatementOutputTypeDef#
# StatementOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import StatementOutputTypeDef
def get_value() -> StatementOutputTypeDef:
return {
"ByteMatchStatement": ...,
}
# StatementOutputTypeDef definition
class StatementOutputTypeDef(TypedDict):
ByteMatchStatement: NotRequired[ByteMatchStatementOutputTypeDef], # (1)
SqliMatchStatement: NotRequired[SqliMatchStatementOutputTypeDef], # (2)
XssMatchStatement: NotRequired[XssMatchStatementOutputTypeDef], # (3)
SizeConstraintStatement: NotRequired[SizeConstraintStatementOutputTypeDef], # (4)
GeoMatchStatement: NotRequired[GeoMatchStatementOutputTypeDef], # (5)
RuleGroupReferenceStatement: NotRequired[RuleGroupReferenceStatementOutputTypeDef], # (6)
IPSetReferenceStatement: NotRequired[IPSetReferenceStatementTypeDef], # (7)
RegexPatternSetReferenceStatement: NotRequired[RegexPatternSetReferenceStatementOutputTypeDef], # (8)
RateBasedStatement: NotRequired[RateBasedStatementOutputTypeDef], # (9)
AndStatement: NotRequired[AndStatementOutputTypeDef], # (10)
OrStatement: NotRequired[OrStatementOutputTypeDef], # (11)
NotStatement: NotRequired[NotStatementOutputTypeDef], # (12)
ManagedRuleGroupStatement: NotRequired[ManagedRuleGroupStatementOutputTypeDef], # (13)
LabelMatchStatement: NotRequired[LabelMatchStatementTypeDef], # (14)
RegexMatchStatement: NotRequired[RegexMatchStatementOutputTypeDef], # (15)- See ByteMatchStatementOutputTypeDef
- See SqliMatchStatementOutputTypeDef
- See XssMatchStatementOutputTypeDef
- See SizeConstraintStatementOutputTypeDef
- See GeoMatchStatementOutputTypeDef
- See RuleGroupReferenceStatementOutputTypeDef
- See IPSetReferenceStatementTypeDef
- See RegexPatternSetReferenceStatementOutputTypeDef
- See RateBasedStatementOutputTypeDef
- See AndStatementOutputTypeDef
- See OrStatementOutputTypeDef
- See NotStatementOutputTypeDef
- See ManagedRuleGroupStatementOutputTypeDef
- See LabelMatchStatementTypeDef
- See RegexMatchStatementOutputTypeDef
ByteMatchStatementTypeDef#
# ByteMatchStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ByteMatchStatementTypeDef
def get_value() -> ByteMatchStatementTypeDef:
return {
"SearchString": ...,
}
# ByteMatchStatementTypeDef definition
class ByteMatchStatementTypeDef(TypedDict):
SearchString: BlobTypeDef,
FieldToMatch: FieldToMatchUnionTypeDef, # (1)
TextTransformations: Sequence[TextTransformationTypeDef], # (2)
PositionalConstraint: PositionalConstraintType, # (3)- See FieldToMatchTypeDef FieldToMatchOutputTypeDef
- See TextTransformationTypeDef
- See PositionalConstraintType
RegexMatchStatementTypeDef#
# RegexMatchStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RegexMatchStatementTypeDef
def get_value() -> RegexMatchStatementTypeDef:
return {
"RegexString": ...,
}
# RegexMatchStatementTypeDef definition
class RegexMatchStatementTypeDef(TypedDict):
RegexString: str,
FieldToMatch: FieldToMatchUnionTypeDef, # (1)
TextTransformations: Sequence[TextTransformationTypeDef], # (2)RegexPatternSetReferenceStatementTypeDef#
# RegexPatternSetReferenceStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RegexPatternSetReferenceStatementTypeDef
def get_value() -> RegexPatternSetReferenceStatementTypeDef:
return {
"ARN": ...,
}
# RegexPatternSetReferenceStatementTypeDef definition
class RegexPatternSetReferenceStatementTypeDef(TypedDict):
ARN: str,
FieldToMatch: FieldToMatchUnionTypeDef, # (1)
TextTransformations: Sequence[TextTransformationTypeDef], # (2)SizeConstraintStatementTypeDef#
# SizeConstraintStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import SizeConstraintStatementTypeDef
def get_value() -> SizeConstraintStatementTypeDef:
return {
"FieldToMatch": ...,
}
# SizeConstraintStatementTypeDef definition
class SizeConstraintStatementTypeDef(TypedDict):
FieldToMatch: FieldToMatchUnionTypeDef, # (1)
ComparisonOperator: ComparisonOperatorType, # (2)
Size: int,
TextTransformations: Sequence[TextTransformationTypeDef], # (3)- See FieldToMatchTypeDef FieldToMatchOutputTypeDef
- See ComparisonOperatorType
- See TextTransformationTypeDef
SqliMatchStatementTypeDef#
# SqliMatchStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import SqliMatchStatementTypeDef
def get_value() -> SqliMatchStatementTypeDef:
return {
"FieldToMatch": ...,
}
# SqliMatchStatementTypeDef definition
class SqliMatchStatementTypeDef(TypedDict):
FieldToMatch: FieldToMatchUnionTypeDef, # (1)
TextTransformations: Sequence[TextTransformationTypeDef], # (2)
SensitivityLevel: NotRequired[SensitivityLevelType], # (3)- See FieldToMatchTypeDef FieldToMatchOutputTypeDef
- See TextTransformationTypeDef
- See SensitivityLevelType
XssMatchStatementTypeDef#
# XssMatchStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import XssMatchStatementTypeDef
def get_value() -> XssMatchStatementTypeDef:
return {
"FieldToMatch": ...,
}
# XssMatchStatementTypeDef definition
class XssMatchStatementTypeDef(TypedDict):
FieldToMatch: FieldToMatchUnionTypeDef, # (1)
TextTransformations: Sequence[TextTransformationTypeDef], # (2)ManagedRuleGroupConfigTypeDef#
# ManagedRuleGroupConfigTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ManagedRuleGroupConfigTypeDef
def get_value() -> ManagedRuleGroupConfigTypeDef:
return {
"LoginPath": ...,
}
# ManagedRuleGroupConfigTypeDef definition
class ManagedRuleGroupConfigTypeDef(TypedDict):
LoginPath: NotRequired[str],
PayloadType: NotRequired[PayloadTypeType], # (1)
UsernameField: NotRequired[UsernameFieldTypeDef], # (2)
PasswordField: NotRequired[PasswordFieldTypeDef], # (3)
AWSManagedRulesBotControlRuleSet: NotRequired[AWSManagedRulesBotControlRuleSetTypeDef], # (4)
AWSManagedRulesATPRuleSet: NotRequired[AWSManagedRulesATPRuleSetUnionTypeDef], # (5)
AWSManagedRulesACFPRuleSet: NotRequired[AWSManagedRulesACFPRuleSetUnionTypeDef], # (6)- See PayloadTypeType
- See UsernameFieldTypeDef
- See PasswordFieldTypeDef
- See AWSManagedRulesBotControlRuleSetTypeDef
- See AWSManagedRulesATPRuleSetTypeDef AWSManagedRulesATPRuleSetOutputTypeDef
- See AWSManagedRulesACFPRuleSetTypeDef AWSManagedRulesACFPRuleSetOutputTypeDef
FirewallManagerRuleGroupTypeDef#
# FirewallManagerRuleGroupTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import FirewallManagerRuleGroupTypeDef
def get_value() -> FirewallManagerRuleGroupTypeDef:
return {
"Name": ...,
}
# FirewallManagerRuleGroupTypeDef definition
class FirewallManagerRuleGroupTypeDef(TypedDict):
Name: str,
Priority: int,
FirewallManagerStatement: FirewallManagerStatementTypeDef, # (1)
OverrideAction: OverrideActionOutputTypeDef, # (2)
VisibilityConfig: VisibilityConfigTypeDef, # (3)RuleOutputTypeDef#
# RuleOutputTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RuleOutputTypeDef
def get_value() -> RuleOutputTypeDef:
return {
"Name": ...,
}
# RuleOutputTypeDef definition
class RuleOutputTypeDef(TypedDict):
Name: str,
Priority: int,
Statement: StatementOutputTypeDef, # (1)
VisibilityConfig: VisibilityConfigTypeDef, # (5)
Action: NotRequired[RuleActionOutputTypeDef], # (2)
OverrideAction: NotRequired[OverrideActionOutputTypeDef], # (3)
RuleLabels: NotRequired[List[LabelTypeDef]], # (4)
CaptchaConfig: NotRequired[CaptchaConfigTypeDef], # (6)
ChallengeConfig: NotRequired[ChallengeConfigTypeDef], # (7)- See StatementOutputTypeDef
- See RuleActionOutputTypeDef
- See OverrideActionOutputTypeDef
- See LabelTypeDef
- See VisibilityConfigTypeDef
- See CaptchaConfigTypeDef
- See ChallengeConfigTypeDef
RuleActionOverrideTypeDef#
# RuleActionOverrideTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RuleActionOverrideTypeDef
def get_value() -> RuleActionOverrideTypeDef:
return {
"Name": ...,
}
# RuleActionOverrideTypeDef definition
class RuleActionOverrideTypeDef(TypedDict):
Name: str,
ActionToUse: RuleActionUnionTypeDef, # (1)PutLoggingConfigurationRequestTypeDef#
# PutLoggingConfigurationRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import PutLoggingConfigurationRequestTypeDef
def get_value() -> PutLoggingConfigurationRequestTypeDef:
return {
"LoggingConfiguration": ...,
}
# PutLoggingConfigurationRequestTypeDef definition
class PutLoggingConfigurationRequestTypeDef(TypedDict):
LoggingConfiguration: LoggingConfigurationUnionTypeDef, # (1)RuleGroupTypeDef#
# RuleGroupTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RuleGroupTypeDef
def get_value() -> RuleGroupTypeDef:
return {
"Name": ...,
}
# RuleGroupTypeDef definition
class RuleGroupTypeDef(TypedDict):
Name: str,
Id: str,
Capacity: int,
ARN: str,
VisibilityConfig: VisibilityConfigTypeDef, # (2)
Description: NotRequired[str],
Rules: NotRequired[List[RuleOutputTypeDef]], # (1)
LabelNamespace: NotRequired[str],
CustomResponseBodies: NotRequired[Dict[str, CustomResponseBodyTypeDef]], # (3)
AvailableLabels: NotRequired[List[LabelSummaryTypeDef]], # (4)
ConsumedLabels: NotRequired[List[LabelSummaryTypeDef]], # (4)- See RuleOutputTypeDef
- See VisibilityConfigTypeDef
- See CustomResponseBodyTypeDef
- See LabelSummaryTypeDef
- See LabelSummaryTypeDef
WebACLTypeDef#
# WebACLTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import WebACLTypeDef
def get_value() -> WebACLTypeDef:
return {
"Name": ...,
}
# WebACLTypeDef definition
class WebACLTypeDef(TypedDict):
Name: str,
Id: str,
ARN: str,
DefaultAction: DefaultActionOutputTypeDef, # (1)
VisibilityConfig: VisibilityConfigTypeDef, # (3)
Description: NotRequired[str],
Rules: NotRequired[List[RuleOutputTypeDef]], # (2)
DataProtectionConfig: NotRequired[DataProtectionConfigOutputTypeDef], # (4)
Capacity: NotRequired[int],
PreProcessFirewallManagerRuleGroups: NotRequired[List[FirewallManagerRuleGroupTypeDef]], # (5)
PostProcessFirewallManagerRuleGroups: NotRequired[List[FirewallManagerRuleGroupTypeDef]], # (5)
ManagedByFirewallManager: NotRequired[bool],
LabelNamespace: NotRequired[str],
CustomResponseBodies: NotRequired[Dict[str, CustomResponseBodyTypeDef]], # (7)
CaptchaConfig: NotRequired[CaptchaConfigTypeDef], # (8)
ChallengeConfig: NotRequired[ChallengeConfigTypeDef], # (9)
TokenDomains: NotRequired[List[str]],
AssociationConfig: NotRequired[AssociationConfigOutputTypeDef], # (10)
RetrofittedByFirewallManager: NotRequired[bool],- See DefaultActionOutputTypeDef
- See RuleOutputTypeDef
- See VisibilityConfigTypeDef
- See DataProtectionConfigOutputTypeDef
- See FirewallManagerRuleGroupTypeDef
- See FirewallManagerRuleGroupTypeDef
- See CustomResponseBodyTypeDef
- See CaptchaConfigTypeDef
- See ChallengeConfigTypeDef
- See AssociationConfigOutputTypeDef
GetRuleGroupResponseTypeDef#
# GetRuleGroupResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetRuleGroupResponseTypeDef
def get_value() -> GetRuleGroupResponseTypeDef:
return {
"RuleGroup": ...,
}
# GetRuleGroupResponseTypeDef definition
class GetRuleGroupResponseTypeDef(TypedDict):
RuleGroup: RuleGroupTypeDef, # (1)
LockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetWebACLForResourceResponseTypeDef#
# GetWebACLForResourceResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetWebACLForResourceResponseTypeDef
def get_value() -> GetWebACLForResourceResponseTypeDef:
return {
"WebACL": ...,
}
# GetWebACLForResourceResponseTypeDef definition
class GetWebACLForResourceResponseTypeDef(TypedDict):
WebACL: WebACLTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See WebACLTypeDef
- See ResponseMetadataTypeDef
GetWebACLResponseTypeDef#
# GetWebACLResponseTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import GetWebACLResponseTypeDef
def get_value() -> GetWebACLResponseTypeDef:
return {
"WebACL": ...,
}
# GetWebACLResponseTypeDef definition
class GetWebACLResponseTypeDef(TypedDict):
WebACL: WebACLTypeDef, # (1)
LockToken: str,
ApplicationIntegrationURL: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See WebACLTypeDef
- See ResponseMetadataTypeDef
ManagedRuleGroupStatementTypeDef#
# ManagedRuleGroupStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import ManagedRuleGroupStatementTypeDef
def get_value() -> ManagedRuleGroupStatementTypeDef:
return {
"VendorName": ...,
}
# ManagedRuleGroupStatementTypeDef definition
class ManagedRuleGroupStatementTypeDef(TypedDict):
VendorName: str,
Name: str,
Version: NotRequired[str],
ExcludedRules: NotRequired[Sequence[ExcludedRuleTypeDef]], # (1)
ScopeDownStatement: NotRequired[Mapping[str, Any]],
ManagedRuleGroupConfigs: NotRequired[Sequence[ManagedRuleGroupConfigUnionTypeDef]], # (2)
RuleActionOverrides: NotRequired[Sequence[RuleActionOverrideUnionTypeDef]], # (3)- See ExcludedRuleTypeDef
- See ManagedRuleGroupConfigTypeDef ManagedRuleGroupConfigOutputTypeDef
- See RuleActionOverrideTypeDef RuleActionOverrideOutputTypeDef
RuleGroupReferenceStatementTypeDef#
# RuleGroupReferenceStatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RuleGroupReferenceStatementTypeDef
def get_value() -> RuleGroupReferenceStatementTypeDef:
return {
"ARN": ...,
}
# RuleGroupReferenceStatementTypeDef definition
class RuleGroupReferenceStatementTypeDef(TypedDict):
ARN: str,
ExcludedRules: NotRequired[Sequence[ExcludedRuleTypeDef]], # (1)
RuleActionOverrides: NotRequired[Sequence[RuleActionOverrideUnionTypeDef]], # (2)StatementTypeDef#
# StatementTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import StatementTypeDef
def get_value() -> StatementTypeDef:
return {
"ByteMatchStatement": ...,
}
# StatementTypeDef definition
class StatementTypeDef(TypedDict):
ByteMatchStatement: NotRequired[ByteMatchStatementUnionTypeDef], # (1)
SqliMatchStatement: NotRequired[SqliMatchStatementUnionTypeDef], # (2)
XssMatchStatement: NotRequired[XssMatchStatementUnionTypeDef], # (3)
SizeConstraintStatement: NotRequired[SizeConstraintStatementUnionTypeDef], # (4)
GeoMatchStatement: NotRequired[GeoMatchStatementUnionTypeDef], # (5)
RuleGroupReferenceStatement: NotRequired[RuleGroupReferenceStatementUnionTypeDef], # (6)
IPSetReferenceStatement: NotRequired[IPSetReferenceStatementTypeDef], # (7)
RegexPatternSetReferenceStatement: NotRequired[RegexPatternSetReferenceStatementUnionTypeDef], # (8)
RateBasedStatement: NotRequired[RateBasedStatementUnionTypeDef], # (9)
AndStatement: NotRequired[AndStatementUnionTypeDef], # (10)
OrStatement: NotRequired[OrStatementUnionTypeDef], # (11)
NotStatement: NotRequired[NotStatementUnionTypeDef], # (12)
ManagedRuleGroupStatement: NotRequired[ManagedRuleGroupStatementUnionTypeDef], # (13)
LabelMatchStatement: NotRequired[LabelMatchStatementTypeDef], # (14)
RegexMatchStatement: NotRequired[RegexMatchStatementUnionTypeDef], # (15)- See ByteMatchStatementTypeDef ByteMatchStatementOutputTypeDef
- See SqliMatchStatementTypeDef SqliMatchStatementOutputTypeDef
- See XssMatchStatementTypeDef XssMatchStatementOutputTypeDef
- See SizeConstraintStatementTypeDef SizeConstraintStatementOutputTypeDef
- See GeoMatchStatementTypeDef GeoMatchStatementOutputTypeDef
- See RuleGroupReferenceStatementTypeDef RuleGroupReferenceStatementOutputTypeDef
- See IPSetReferenceStatementTypeDef
- See RegexPatternSetReferenceStatementTypeDef RegexPatternSetReferenceStatementOutputTypeDef
- See RateBasedStatementTypeDef RateBasedStatementOutputTypeDef
- See AndStatementTypeDef AndStatementOutputTypeDef
- See OrStatementTypeDef OrStatementOutputTypeDef
- See NotStatementTypeDef NotStatementOutputTypeDef
- See ManagedRuleGroupStatementTypeDef ManagedRuleGroupStatementOutputTypeDef
- See LabelMatchStatementTypeDef
- See RegexMatchStatementTypeDef RegexMatchStatementOutputTypeDef
RuleTypeDef#
# RuleTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import RuleTypeDef
def get_value() -> RuleTypeDef:
return {
"Name": ...,
}
# RuleTypeDef definition
class RuleTypeDef(TypedDict):
Name: str,
Priority: int,
Statement: StatementUnionTypeDef, # (1)
VisibilityConfig: VisibilityConfigTypeDef, # (5)
Action: NotRequired[RuleActionUnionTypeDef], # (2)
OverrideAction: NotRequired[OverrideActionUnionTypeDef], # (3)
RuleLabels: NotRequired[Sequence[LabelTypeDef]], # (4)
CaptchaConfig: NotRequired[CaptchaConfigTypeDef], # (6)
ChallengeConfig: NotRequired[ChallengeConfigTypeDef], # (7)- See StatementTypeDef StatementOutputTypeDef
- See RuleActionTypeDef RuleActionOutputTypeDef
- See OverrideActionTypeDef OverrideActionOutputTypeDef
- See LabelTypeDef
- See VisibilityConfigTypeDef
- See CaptchaConfigTypeDef
- See ChallengeConfigTypeDef
CheckCapacityRequestTypeDef#
# CheckCapacityRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CheckCapacityRequestTypeDef
def get_value() -> CheckCapacityRequestTypeDef:
return {
"Scope": ...,
}
# CheckCapacityRequestTypeDef definition
class CheckCapacityRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
Rules: Sequence[RuleUnionTypeDef], # (2)- See ScopeType
- See RuleTypeDef RuleOutputTypeDef
CreateRuleGroupRequestTypeDef#
# CreateRuleGroupRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CreateRuleGroupRequestTypeDef
def get_value() -> CreateRuleGroupRequestTypeDef:
return {
"Name": ...,
}
# CreateRuleGroupRequestTypeDef definition
class CreateRuleGroupRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Capacity: int,
VisibilityConfig: VisibilityConfigTypeDef, # (2)
Description: NotRequired[str],
Rules: NotRequired[Sequence[RuleUnionTypeDef]], # (3)
Tags: NotRequired[Sequence[TagTypeDef]], # (4)
CustomResponseBodies: NotRequired[Mapping[str, CustomResponseBodyTypeDef]], # (5)- See ScopeType
- See VisibilityConfigTypeDef
- See RuleTypeDef RuleOutputTypeDef
- See TagTypeDef
- See CustomResponseBodyTypeDef
CreateWebACLRequestTypeDef#
# CreateWebACLRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import CreateWebACLRequestTypeDef
def get_value() -> CreateWebACLRequestTypeDef:
return {
"Name": ...,
}
# CreateWebACLRequestTypeDef definition
class CreateWebACLRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
DefaultAction: DefaultActionUnionTypeDef, # (2)
VisibilityConfig: VisibilityConfigTypeDef, # (3)
Description: NotRequired[str],
Rules: NotRequired[Sequence[RuleUnionTypeDef]], # (4)
DataProtectionConfig: NotRequired[DataProtectionConfigUnionTypeDef], # (5)
Tags: NotRequired[Sequence[TagTypeDef]], # (6)
CustomResponseBodies: NotRequired[Mapping[str, CustomResponseBodyTypeDef]], # (7)
CaptchaConfig: NotRequired[CaptchaConfigTypeDef], # (8)
ChallengeConfig: NotRequired[ChallengeConfigTypeDef], # (9)
TokenDomains: NotRequired[Sequence[str]],
AssociationConfig: NotRequired[AssociationConfigUnionTypeDef], # (10)- See ScopeType
- See DefaultActionTypeDef DefaultActionOutputTypeDef
- See VisibilityConfigTypeDef
- See RuleTypeDef RuleOutputTypeDef
- See DataProtectionConfigTypeDef DataProtectionConfigOutputTypeDef
- See TagTypeDef
- See CustomResponseBodyTypeDef
- See CaptchaConfigTypeDef
- See ChallengeConfigTypeDef
- See AssociationConfigTypeDef AssociationConfigOutputTypeDef
UpdateRuleGroupRequestTypeDef#
# UpdateRuleGroupRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import UpdateRuleGroupRequestTypeDef
def get_value() -> UpdateRuleGroupRequestTypeDef:
return {
"Name": ...,
}
# UpdateRuleGroupRequestTypeDef definition
class UpdateRuleGroupRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
VisibilityConfig: VisibilityConfigTypeDef, # (2)
LockToken: str,
Description: NotRequired[str],
Rules: NotRequired[Sequence[RuleUnionTypeDef]], # (3)
CustomResponseBodies: NotRequired[Mapping[str, CustomResponseBodyTypeDef]], # (4)- See ScopeType
- See VisibilityConfigTypeDef
- See RuleTypeDef RuleOutputTypeDef
- See CustomResponseBodyTypeDef
UpdateWebACLRequestTypeDef#
# UpdateWebACLRequestTypeDef TypedDict usage example
from types_boto3_wafv2.type_defs import UpdateWebACLRequestTypeDef
def get_value() -> UpdateWebACLRequestTypeDef:
return {
"Name": ...,
}
# UpdateWebACLRequestTypeDef definition
class UpdateWebACLRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
DefaultAction: DefaultActionUnionTypeDef, # (2)
VisibilityConfig: VisibilityConfigTypeDef, # (3)
LockToken: str,
Description: NotRequired[str],
Rules: NotRequired[Sequence[RuleUnionTypeDef]], # (4)
DataProtectionConfig: NotRequired[DataProtectionConfigUnionTypeDef], # (5)
CustomResponseBodies: NotRequired[Mapping[str, CustomResponseBodyTypeDef]], # (6)
CaptchaConfig: NotRequired[CaptchaConfigTypeDef], # (7)
ChallengeConfig: NotRequired[ChallengeConfigTypeDef], # (8)
TokenDomains: NotRequired[Sequence[str]],
AssociationConfig: NotRequired[AssociationConfigUnionTypeDef], # (9)- See ScopeType
- See DefaultActionTypeDef DefaultActionOutputTypeDef
- See VisibilityConfigTypeDef
- See RuleTypeDef RuleOutputTypeDef
- See DataProtectionConfigTypeDef DataProtectionConfigOutputTypeDef
- See CustomResponseBodyTypeDef
- See CaptchaConfigTypeDef
- See ChallengeConfigTypeDef
- See AssociationConfigTypeDef AssociationConfigOutputTypeDef