Typed dictionaries
Auto-generated documentation for WAFV2 type annotations stubs module mypy-boto3-wafv2.
AWSManagedRulesBotControlRuleSetTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import AWSManagedRulesBotControlRuleSetTypeDef
def get_value() -> AWSManagedRulesBotControlRuleSetTypeDef:
return {
"InspectionLevel": ...,
}
Definition
class AWSManagedRulesBotControlRuleSetTypeDef(TypedDict):
InspectionLevel: InspectionLevelType, # (1)
ActionConditionTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ActionConditionTypeDef
def get_value() -> ActionConditionTypeDef:
return {
"Action": ...,
}
- See ActionValueType
AndStatementTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import AndStatementTypeDef
def get_value() -> AndStatementTypeDef:
return {
"Statements": ...,
}
- See StatementTypeDef
AssociateWebACLRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import AssociateWebACLRequestRequestTypeDef
def get_value() -> AssociateWebACLRequestRequestTypeDef:
return {
"WebACLArn": ...,
"ResourceArn": ...,
}
BodyTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import BodyTypeDef
def get_value() -> BodyTypeDef:
return {
"OversizeHandling": ...,
}
TextTransformationTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import TextTransformationTypeDef
def get_value() -> TextTransformationTypeDef:
return {
"Priority": ...,
"Type": ...,
}
Definition
class TextTransformationTypeDef(TypedDict):
Priority: int,
Type: TextTransformationTypeType, # (1)
ImmunityTimePropertyTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ImmunityTimePropertyTypeDef
def get_value() -> ImmunityTimePropertyTypeDef:
return {
"ImmunityTime": ...,
}
CaptchaResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import CaptchaResponseTypeDef
def get_value() -> CaptchaResponseTypeDef:
return {
"ResponseCode": ...,
}
Definition
class CaptchaResponseTypeDef(TypedDict):
ResponseCode: NotRequired[int],
SolveTimestamp: NotRequired[int],
FailureReason: NotRequired[FailureReasonType], # (1)
ChallengeResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ChallengeResponseTypeDef
def get_value() -> ChallengeResponseTypeDef:
return {
"ResponseCode": ...,
}
Definition
class ChallengeResponseTypeDef(TypedDict):
ResponseCode: NotRequired[int],
SolveTimestamp: NotRequired[int],
FailureReason: NotRequired[FailureReasonType], # (1)
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
LabelNameConditionTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import LabelNameConditionTypeDef
def get_value() -> LabelNameConditionTypeDef:
return {
"LabelName": ...,
}
CookieMatchPatternTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import CookieMatchPatternTypeDef
def get_value() -> CookieMatchPatternTypeDef:
return {
"All": ...,
}
Definition
class CookieMatchPatternTypeDef(TypedDict):
All: NotRequired[Mapping[str, Any]],
IncludedCookies: NotRequired[Sequence[str]],
ExcludedCookies: NotRequired[Sequence[str]],
TagTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
IPSetSummaryTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import IPSetSummaryTypeDef
def get_value() -> IPSetSummaryTypeDef:
return {
"Name": ...,
}
Definition
class IPSetSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
Description: NotRequired[str],
LockToken: NotRequired[str],
ARN: NotRequired[str],
RegexTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import RegexTypeDef
def get_value() -> RegexTypeDef:
return {
"RegexString": ...,
}
RegexPatternSetSummaryTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import RegexPatternSetSummaryTypeDef
def get_value() -> RegexPatternSetSummaryTypeDef:
return {
"Name": ...,
}
Definition
class RegexPatternSetSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
Description: NotRequired[str],
LockToken: NotRequired[str],
ARN: NotRequired[str],
CustomResponseBodyTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import CustomResponseBodyTypeDef
def get_value() -> CustomResponseBodyTypeDef:
return {
"ContentType": ...,
"Content": ...,
}
Definition
class CustomResponseBodyTypeDef(TypedDict):
ContentType: ResponseContentTypeType, # (1)
Content: str,
VisibilityConfigTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import VisibilityConfigTypeDef
def get_value() -> VisibilityConfigTypeDef:
return {
"SampledRequestsEnabled": ...,
"CloudWatchMetricsEnabled": ...,
"MetricName": ...,
}
Definition
class VisibilityConfigTypeDef(TypedDict):
SampledRequestsEnabled: bool,
CloudWatchMetricsEnabled: bool,
MetricName: str,
RuleGroupSummaryTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import RuleGroupSummaryTypeDef
def get_value() -> RuleGroupSummaryTypeDef:
return {
"Name": ...,
}
Definition
class RuleGroupSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
Description: NotRequired[str],
LockToken: NotRequired[str],
ARN: NotRequired[str],
WebACLSummaryTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import WebACLSummaryTypeDef
def get_value() -> WebACLSummaryTypeDef:
return {
"Name": ...,
}
Definition
class WebACLSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
Description: NotRequired[str],
LockToken: NotRequired[str],
ARN: NotRequired[str],
CustomHTTPHeaderTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import CustomHTTPHeaderTypeDef
def get_value() -> CustomHTTPHeaderTypeDef:
return {
"Name": ...,
"Value": ...,
}
DeleteFirewallManagerRuleGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import DeleteFirewallManagerRuleGroupsRequestRequestTypeDef
def get_value() -> DeleteFirewallManagerRuleGroupsRequestRequestTypeDef:
return {
"WebACLArn": ...,
"WebACLLockToken": ...,
}
Definition
class DeleteFirewallManagerRuleGroupsRequestRequestTypeDef(TypedDict):
WebACLArn: str,
WebACLLockToken: str,
DeleteIPSetRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import DeleteIPSetRequestRequestTypeDef
def get_value() -> DeleteIPSetRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"Id": ...,
"LockToken": ...,
}
Definition
class DeleteIPSetRequestRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,
- See ScopeType
DeleteLoggingConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import DeleteLoggingConfigurationRequestRequestTypeDef
def get_value() -> DeleteLoggingConfigurationRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
DeletePermissionPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import DeletePermissionPolicyRequestRequestTypeDef
def get_value() -> DeletePermissionPolicyRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
DeleteRegexPatternSetRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import DeleteRegexPatternSetRequestRequestTypeDef
def get_value() -> DeleteRegexPatternSetRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"Id": ...,
"LockToken": ...,
}
Definition
class DeleteRegexPatternSetRequestRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,
- See ScopeType
DeleteRuleGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import DeleteRuleGroupRequestRequestTypeDef
def get_value() -> DeleteRuleGroupRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"Id": ...,
"LockToken": ...,
}
Definition
class DeleteRuleGroupRequestRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,
- See ScopeType
DeleteWebACLRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import DeleteWebACLRequestRequestTypeDef
def get_value() -> DeleteWebACLRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"Id": ...,
"LockToken": ...,
}
Definition
class DeleteWebACLRequestRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,
- See ScopeType
DescribeManagedRuleGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import DescribeManagedRuleGroupRequestRequestTypeDef
def get_value() -> DescribeManagedRuleGroupRequestRequestTypeDef:
return {
"VendorName": ...,
"Name": ...,
"Scope": ...,
}
Definition
class DescribeManagedRuleGroupRequestRequestTypeDef(TypedDict):
VendorName: str,
Name: str,
Scope: ScopeType, # (1)
VersionName: NotRequired[str],
- See ScopeType
LabelSummaryTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import LabelSummaryTypeDef
def get_value() -> LabelSummaryTypeDef:
return {
"Name": ...,
}
DisassociateWebACLRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import DisassociateWebACLRequestRequestTypeDef
def get_value() -> DisassociateWebACLRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
ExcludedRuleTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ExcludedRuleTypeDef
def get_value() -> ExcludedRuleTypeDef:
return {
"Name": ...,
}
SingleHeaderTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import SingleHeaderTypeDef
def get_value() -> SingleHeaderTypeDef:
return {
"Name": ...,
}
SingleQueryArgumentTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import SingleQueryArgumentTypeDef
def get_value() -> SingleQueryArgumentTypeDef:
return {
"Name": ...,
}
ForwardedIPConfigTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ForwardedIPConfigTypeDef
def get_value() -> ForwardedIPConfigTypeDef:
return {
"HeaderName": ...,
"FallbackBehavior": ...,
}
Definition
class ForwardedIPConfigTypeDef(TypedDict):
HeaderName: str,
FallbackBehavior: FallbackBehaviorType, # (1)
GenerateMobileSdkReleaseUrlRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GenerateMobileSdkReleaseUrlRequestRequestTypeDef
def get_value() -> GenerateMobileSdkReleaseUrlRequestRequestTypeDef:
return {
"Platform": ...,
"ReleaseVersion": ...,
}
Definition
class GenerateMobileSdkReleaseUrlRequestRequestTypeDef(TypedDict):
Platform: PlatformType, # (1)
ReleaseVersion: str,
- See PlatformType
GetIPSetRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GetIPSetRequestRequestTypeDef
def get_value() -> GetIPSetRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"Id": ...,
}
Definition
class GetIPSetRequestRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
- See ScopeType
IPSetTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import IPSetTypeDef
def get_value() -> IPSetTypeDef:
return {
"Name": ...,
"Id": ...,
"ARN": ...,
"IPAddressVersion": ...,
"Addresses": ...,
}
Definition
class IPSetTypeDef(TypedDict):
Name: str,
Id: str,
ARN: str,
IPAddressVersion: IPAddressVersionType, # (1)
Addresses: List[str],
Description: NotRequired[str],
GetLoggingConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GetLoggingConfigurationRequestRequestTypeDef
def get_value() -> GetLoggingConfigurationRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
GetManagedRuleSetRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GetManagedRuleSetRequestRequestTypeDef
def get_value() -> GetManagedRuleSetRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"Id": ...,
}
Definition
class GetManagedRuleSetRequestRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
- See ScopeType
GetMobileSdkReleaseRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GetMobileSdkReleaseRequestRequestTypeDef
def get_value() -> GetMobileSdkReleaseRequestRequestTypeDef:
return {
"Platform": ...,
"ReleaseVersion": ...,
}
Definition
class GetMobileSdkReleaseRequestRequestTypeDef(TypedDict):
Platform: PlatformType, # (1)
ReleaseVersion: str,
- See PlatformType
GetPermissionPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GetPermissionPolicyRequestRequestTypeDef
def get_value() -> GetPermissionPolicyRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
GetRateBasedStatementManagedKeysRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GetRateBasedStatementManagedKeysRequestRequestTypeDef
def get_value() -> GetRateBasedStatementManagedKeysRequestRequestTypeDef:
return {
"Scope": ...,
"WebACLName": ...,
"WebACLId": ...,
"RuleName": ...,
}
Definition
class GetRateBasedStatementManagedKeysRequestRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
WebACLName: str,
WebACLId: str,
RuleName: str,
RuleGroupRuleName: NotRequired[str],
- See ScopeType
RateBasedStatementManagedKeysIPSetTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import RateBasedStatementManagedKeysIPSetTypeDef
def get_value() -> RateBasedStatementManagedKeysIPSetTypeDef:
return {
"IPAddressVersion": ...,
}
Definition
class RateBasedStatementManagedKeysIPSetTypeDef(TypedDict):
IPAddressVersion: NotRequired[IPAddressVersionType], # (1)
Addresses: NotRequired[List[str]],
GetRegexPatternSetRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GetRegexPatternSetRequestRequestTypeDef
def get_value() -> GetRegexPatternSetRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"Id": ...,
}
Definition
class GetRegexPatternSetRequestRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
- See ScopeType
GetRuleGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GetRuleGroupRequestRequestTypeDef
def get_value() -> GetRuleGroupRequestRequestTypeDef:
return {
"Name": ...,
}
Definition
class GetRuleGroupRequestRequestTypeDef(TypedDict):
Name: NotRequired[str],
Scope: NotRequired[ScopeType], # (1)
Id: NotRequired[str],
ARN: NotRequired[str],
- See ScopeType
TimeWindowTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import TimeWindowTypeDef
def get_value() -> TimeWindowTypeDef:
return {
"StartTime": ...,
"EndTime": ...,
}
Definition
class TimeWindowTypeDef(TypedDict):
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
GetWebACLForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GetWebACLForResourceRequestRequestTypeDef
def get_value() -> GetWebACLForResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
GetWebACLRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GetWebACLRequestRequestTypeDef
def get_value() -> GetWebACLRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"Id": ...,
}
Definition
class GetWebACLRequestRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
- See ScopeType
HTTPHeaderTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import HTTPHeaderTypeDef
def get_value() -> HTTPHeaderTypeDef:
return {
"Name": ...,
}
HeaderMatchPatternTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import HeaderMatchPatternTypeDef
def get_value() -> HeaderMatchPatternTypeDef:
return {
"All": ...,
}
Definition
class HeaderMatchPatternTypeDef(TypedDict):
All: NotRequired[Mapping[str, Any]],
IncludedHeaders: NotRequired[Sequence[str]],
ExcludedHeaders: NotRequired[Sequence[str]],
IPSetForwardedIPConfigTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import IPSetForwardedIPConfigTypeDef
def get_value() -> IPSetForwardedIPConfigTypeDef:
return {
"HeaderName": ...,
"FallbackBehavior": ...,
"Position": ...,
}
Definition
class IPSetForwardedIPConfigTypeDef(TypedDict):
HeaderName: str,
FallbackBehavior: FallbackBehaviorType, # (1)
Position: ForwardedIPPositionType, # (2)
JsonMatchPatternTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import JsonMatchPatternTypeDef
def get_value() -> JsonMatchPatternTypeDef:
return {
"All": ...,
}
Definition
class JsonMatchPatternTypeDef(TypedDict):
All: NotRequired[Mapping[str, Any]],
IncludedPaths: NotRequired[Sequence[str]],
LabelMatchStatementTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import LabelMatchStatementTypeDef
def get_value() -> LabelMatchStatementTypeDef:
return {
"Scope": ...,
"Key": ...,
}
LabelTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import LabelTypeDef
def get_value() -> LabelTypeDef:
return {
"Name": ...,
}
ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef
def get_value() -> ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef:
return {
"VendorName": ...,
"Name": ...,
"Scope": ...,
}
Definition
class ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef(TypedDict):
VendorName: str,
Name: str,
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],
- See ScopeType
ManagedRuleGroupVersionTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ManagedRuleGroupVersionTypeDef
def get_value() -> ManagedRuleGroupVersionTypeDef:
return {
"Name": ...,
}
Definition
class ManagedRuleGroupVersionTypeDef(TypedDict):
Name: NotRequired[str],
LastUpdateTimestamp: NotRequired[datetime],
ListAvailableManagedRuleGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListAvailableManagedRuleGroupsRequestRequestTypeDef
def get_value() -> ListAvailableManagedRuleGroupsRequestRequestTypeDef:
return {
"Scope": ...,
}
Definition
class ListAvailableManagedRuleGroupsRequestRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],
- See ScopeType
ManagedRuleGroupSummaryTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ManagedRuleGroupSummaryTypeDef
def get_value() -> ManagedRuleGroupSummaryTypeDef:
return {
"VendorName": ...,
}
Definition
class ManagedRuleGroupSummaryTypeDef(TypedDict):
VendorName: NotRequired[str],
Name: NotRequired[str],
VersioningSupported: NotRequired[bool],
Description: NotRequired[str],
ListIPSetsRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListIPSetsRequestRequestTypeDef
def get_value() -> ListIPSetsRequestRequestTypeDef:
return {
"Scope": ...,
}
Definition
class ListIPSetsRequestRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],
- See ScopeType
ListLoggingConfigurationsRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListLoggingConfigurationsRequestRequestTypeDef
def get_value() -> ListLoggingConfigurationsRequestRequestTypeDef:
return {
"Scope": ...,
}
Definition
class ListLoggingConfigurationsRequestRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],
- See ScopeType
ListManagedRuleSetsRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListManagedRuleSetsRequestRequestTypeDef
def get_value() -> ListManagedRuleSetsRequestRequestTypeDef:
return {
"Scope": ...,
}
Definition
class ListManagedRuleSetsRequestRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],
- See ScopeType
ManagedRuleSetSummaryTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ManagedRuleSetSummaryTypeDef
def get_value() -> ManagedRuleSetSummaryTypeDef:
return {
"Name": ...,
}
Definition
class ManagedRuleSetSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
Description: NotRequired[str],
LockToken: NotRequired[str],
ARN: NotRequired[str],
LabelNamespace: NotRequired[str],
ListMobileSdkReleasesRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListMobileSdkReleasesRequestRequestTypeDef
def get_value() -> ListMobileSdkReleasesRequestRequestTypeDef:
return {
"Platform": ...,
}
Definition
class ListMobileSdkReleasesRequestRequestTypeDef(TypedDict):
Platform: PlatformType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],
- See PlatformType
ReleaseSummaryTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ReleaseSummaryTypeDef
def get_value() -> ReleaseSummaryTypeDef:
return {
"ReleaseVersion": ...,
}
Definition
class ReleaseSummaryTypeDef(TypedDict):
ReleaseVersion: NotRequired[str],
Timestamp: NotRequired[datetime],
ListRegexPatternSetsRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListRegexPatternSetsRequestRequestTypeDef
def get_value() -> ListRegexPatternSetsRequestRequestTypeDef:
return {
"Scope": ...,
}
Definition
class ListRegexPatternSetsRequestRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],
- See ScopeType
ListResourcesForWebACLRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListResourcesForWebACLRequestRequestTypeDef
def get_value() -> ListResourcesForWebACLRequestRequestTypeDef:
return {
"WebACLArn": ...,
}
Definition
class ListResourcesForWebACLRequestRequestTypeDef(TypedDict):
WebACLArn: str,
ResourceType: NotRequired[ResourceTypeType], # (1)
- See ResourceTypeType
ListRuleGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListRuleGroupsRequestRequestTypeDef
def get_value() -> ListRuleGroupsRequestRequestTypeDef:
return {
"Scope": ...,
}
Definition
class ListRuleGroupsRequestRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],
- See ScopeType
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
}
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
NextMarker: NotRequired[str],
Limit: NotRequired[int],
ListWebACLsRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListWebACLsRequestRequestTypeDef
def get_value() -> ListWebACLsRequestRequestTypeDef:
return {
"Scope": ...,
}
Definition
class ListWebACLsRequestRequestTypeDef(TypedDict):
Scope: ScopeType, # (1)
NextMarker: NotRequired[str],
Limit: NotRequired[int],
- See ScopeType
PasswordFieldTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import PasswordFieldTypeDef
def get_value() -> PasswordFieldTypeDef:
return {
"Identifier": ...,
}
UsernameFieldTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import UsernameFieldTypeDef
def get_value() -> UsernameFieldTypeDef:
return {
"Identifier": ...,
}
ManagedRuleSetVersionTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ManagedRuleSetVersionTypeDef
def get_value() -> ManagedRuleSetVersionTypeDef:
return {
"AssociatedRuleGroupArn": ...,
}
Definition
class ManagedRuleSetVersionTypeDef(TypedDict):
AssociatedRuleGroupArn: NotRequired[str],
Capacity: NotRequired[int],
ForecastedLifetime: NotRequired[int],
PublishTimestamp: NotRequired[datetime],
LastUpdateTimestamp: NotRequired[datetime],
ExpiryTimestamp: NotRequired[datetime],
NotStatementTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import NotStatementTypeDef
def get_value() -> NotStatementTypeDef:
return {
"Statement": ...,
}
- See StatementTypeDef
OrStatementTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import OrStatementTypeDef
def get_value() -> OrStatementTypeDef:
return {
"Statements": ...,
}
- See StatementTypeDef
VersionToPublishTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import VersionToPublishTypeDef
def get_value() -> VersionToPublishTypeDef:
return {
"AssociatedRuleGroupArn": ...,
}
Definition
class VersionToPublishTypeDef(TypedDict):
AssociatedRuleGroupArn: NotRequired[str],
ForecastedLifetime: NotRequired[int],
PutPermissionPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import PutPermissionPolicyRequestRequestTypeDef
def get_value() -> PutPermissionPolicyRequestRequestTypeDef:
return {
"ResourceArn": ...,
"Policy": ...,
}
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateIPSetRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import UpdateIPSetRequestRequestTypeDef
def get_value() -> UpdateIPSetRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"Id": ...,
"Addresses": ...,
"LockToken": ...,
}
Definition
class UpdateIPSetRequestRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
Addresses: Sequence[str],
LockToken: str,
Description: NotRequired[str],
- See ScopeType
UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef
def get_value() -> UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"Id": ...,
"LockToken": ...,
"VersionToExpire": ...,
"ExpiryTimestamp": ...,
}
Definition
class UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,
VersionToExpire: str,
ExpiryTimestamp: Union[datetime, str],
- See ScopeType
CaptchaConfigTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import CaptchaConfigTypeDef
def get_value() -> CaptchaConfigTypeDef:
return {
"ImmunityTimeProperty": ...,
}
Definition
class CaptchaConfigTypeDef(TypedDict):
ImmunityTimeProperty: NotRequired[ImmunityTimePropertyTypeDef], # (1)
ChallengeConfigTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ChallengeConfigTypeDef
def get_value() -> ChallengeConfigTypeDef:
return {
"ImmunityTimeProperty": ...,
}
Definition
class ChallengeConfigTypeDef(TypedDict):
ImmunityTimeProperty: NotRequired[ImmunityTimePropertyTypeDef], # (1)
CheckCapacityResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import CheckCapacityResponseTypeDef
def get_value() -> CheckCapacityResponseTypeDef:
return {
"Capacity": ...,
"ResponseMetadata": ...,
}
Definition
class CheckCapacityResponseTypeDef(TypedDict):
Capacity: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteFirewallManagerRuleGroupsResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import DeleteFirewallManagerRuleGroupsResponseTypeDef
def get_value() -> DeleteFirewallManagerRuleGroupsResponseTypeDef:
return {
"NextWebACLLockToken": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteFirewallManagerRuleGroupsResponseTypeDef(TypedDict):
NextWebACLLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GenerateMobileSdkReleaseUrlResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GenerateMobileSdkReleaseUrlResponseTypeDef
def get_value() -> GenerateMobileSdkReleaseUrlResponseTypeDef:
return {
"Url": ...,
"ResponseMetadata": ...,
}
Definition
class GenerateMobileSdkReleaseUrlResponseTypeDef(TypedDict):
Url: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetPermissionPolicyResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import GetPermissionPolicyResponseTypeDef
def get_value() -> GetPermissionPolicyResponseTypeDef:
return {
"Policy": ...,
"ResponseMetadata": ...,
}
Definition
class GetPermissionPolicyResponseTypeDef(TypedDict):
Policy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListResourcesForWebACLResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListResourcesForWebACLResponseTypeDef
def get_value() -> ListResourcesForWebACLResponseTypeDef:
return {
"ResourceArns": ...,
"ResponseMetadata": ...,
}
Definition
class ListResourcesForWebACLResponseTypeDef(TypedDict):
ResourceArns: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PutManagedRuleSetVersionsResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import PutManagedRuleSetVersionsResponseTypeDef
def get_value() -> PutManagedRuleSetVersionsResponseTypeDef:
return {
"NextLockToken": ...,
"ResponseMetadata": ...,
}
Definition
class PutManagedRuleSetVersionsResponseTypeDef(TypedDict):
NextLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateIPSetResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import UpdateIPSetResponseTypeDef
def get_value() -> UpdateIPSetResponseTypeDef:
return {
"NextLockToken": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateIPSetResponseTypeDef(TypedDict):
NextLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateManagedRuleSetVersionExpiryDateResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import UpdateManagedRuleSetVersionExpiryDateResponseTypeDef
def get_value() -> UpdateManagedRuleSetVersionExpiryDateResponseTypeDef:
return {
"ExpiringVersion": ...,
"ExpiryTimestamp": ...,
"NextLockToken": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateManagedRuleSetVersionExpiryDateResponseTypeDef(TypedDict):
ExpiringVersion: str,
ExpiryTimestamp: datetime,
NextLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateRegexPatternSetResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import UpdateRegexPatternSetResponseTypeDef
def get_value() -> UpdateRegexPatternSetResponseTypeDef:
return {
"NextLockToken": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateRegexPatternSetResponseTypeDef(TypedDict):
NextLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateRuleGroupResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import UpdateRuleGroupResponseTypeDef
def get_value() -> UpdateRuleGroupResponseTypeDef:
return {
"NextLockToken": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateRuleGroupResponseTypeDef(TypedDict):
NextLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateWebACLResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import UpdateWebACLResponseTypeDef
def get_value() -> UpdateWebACLResponseTypeDef:
return {
"NextLockToken": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateWebACLResponseTypeDef(TypedDict):
NextLockToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ConditionTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ConditionTypeDef
def get_value() -> ConditionTypeDef:
return {
"ActionCondition": ...,
}
Definition
class ConditionTypeDef(TypedDict):
ActionCondition: NotRequired[ActionConditionTypeDef], # (1)
LabelNameCondition: NotRequired[LabelNameConditionTypeDef], # (2)
CookiesTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import CookiesTypeDef
def get_value() -> CookiesTypeDef:
return {
"MatchPattern": ...,
"MatchScope": ...,
"OversizeHandling": ...,
}
Definition
class CookiesTypeDef(TypedDict):
MatchPattern: CookieMatchPatternTypeDef, # (1)
MatchScope: MapMatchScopeType, # (2)
OversizeHandling: OversizeHandlingType, # (3)
CreateIPSetRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import CreateIPSetRequestRequestTypeDef
def get_value() -> CreateIPSetRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"IPAddressVersion": ...,
"Addresses": ...,
}
Definition
class CreateIPSetRequestRequestTypeDef(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
Usage Example
from mypy_boto3_wafv2.type_defs import MobileSdkReleaseTypeDef
def get_value() -> MobileSdkReleaseTypeDef:
return {
"ReleaseVersion": ...,
}
Definition
class MobileSdkReleaseTypeDef(TypedDict):
ReleaseVersion: NotRequired[str],
Timestamp: NotRequired[datetime],
ReleaseNotes: NotRequired[str],
Tags: NotRequired[List[TagTypeDef]], # (1)
- See TagTypeDef
TagInfoForResourceTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import TagInfoForResourceTypeDef
def get_value() -> TagInfoForResourceTypeDef:
return {
"ResourceARN": ...,
}
Definition
class TagInfoForResourceTypeDef(TypedDict):
ResourceARN: NotRequired[str],
TagList: NotRequired[List[TagTypeDef]], # (1)
- See TagTypeDef
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"Tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateIPSetResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import CreateIPSetResponseTypeDef
def get_value() -> CreateIPSetResponseTypeDef:
return {
"Summary": ...,
"ResponseMetadata": ...,
}
Definition
class CreateIPSetResponseTypeDef(TypedDict):
Summary: IPSetSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListIPSetsResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListIPSetsResponseTypeDef
def get_value() -> ListIPSetsResponseTypeDef:
return {
"NextMarker": ...,
"IPSets": ...,
"ResponseMetadata": ...,
}
Definition
class ListIPSetsResponseTypeDef(TypedDict):
NextMarker: str,
IPSets: List[IPSetSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateRegexPatternSetRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import CreateRegexPatternSetRequestRequestTypeDef
def get_value() -> CreateRegexPatternSetRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"RegularExpressionList": ...,
}
Definition
class CreateRegexPatternSetRequestRequestTypeDef(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
Usage Example
from mypy_boto3_wafv2.type_defs import RegexPatternSetTypeDef
def get_value() -> RegexPatternSetTypeDef:
return {
"Name": ...,
}
Definition
class RegexPatternSetTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
ARN: NotRequired[str],
Description: NotRequired[str],
RegularExpressionList: NotRequired[List[RegexTypeDef]], # (1)
- See RegexTypeDef
UpdateRegexPatternSetRequestRequestTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import UpdateRegexPatternSetRequestRequestTypeDef
def get_value() -> UpdateRegexPatternSetRequestRequestTypeDef:
return {
"Name": ...,
"Scope": ...,
"Id": ...,
"RegularExpressionList": ...,
"LockToken": ...,
}
Definition
class UpdateRegexPatternSetRequestRequestTypeDef(TypedDict):
Name: str,
Scope: ScopeType, # (1)
Id: str,
RegularExpressionList: Sequence[RegexTypeDef], # (2)
LockToken: str,
Description: NotRequired[str],
- See ScopeType
- See RegexTypeDef
CreateRegexPatternSetResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import CreateRegexPatternSetResponseTypeDef
def get_value() -> CreateRegexPatternSetResponseTypeDef:
return {
"Summary": ...,
"ResponseMetadata": ...,
}
Definition
class CreateRegexPatternSetResponseTypeDef(TypedDict):
Summary: RegexPatternSetSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListRegexPatternSetsResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import ListRegexPatternSetsResponseTypeDef
def get_value() -> ListRegexPatternSetsResponseTypeDef:
return {
"NextMarker": ...,
"RegexPatternSets": ...,
"ResponseMetadata": ...,
}
Definition
class ListRegexPatternSetsResponseTypeDef(TypedDict):
NextMarker: str,
RegexPatternSets: List[RegexPatternSetSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateRuleGroupResponseTypeDef
Usage Example
from mypy_boto3_wafv2.type_defs import CreateRuleGroupResponseTypeDef
def get_value() -> CreateRuleGroupResponseTypeDef:
return {
"Summary": ...,
"ResponseMetadata": ...,
}
Definition
class CreateRuleGroupResponseTypeDef(TypedDict):
Summary: RuleGroupSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)