Typed dictionaries

Index > WAFV2 > 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)

1. See InspectionLevelType

ActionConditionTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ActionConditionTypeDef

def get_value() -> ActionConditionTypeDef:
    return {
        "Action": ...,
    }

Definition

class ActionConditionTypeDef(TypedDict):
    Action: ActionValueType,  # (1)

1. See ActionValueType

AndStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import AndStatementTypeDef

def get_value() -> AndStatementTypeDef:
    return {
        "Statements": ...,
    }

Definition

class AndStatementTypeDef(TypedDict):
    Statements: Sequence[StatementTypeDef],  # (1)

1. See StatementTypeDef

AssociateWebACLRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import AssociateWebACLRequestRequestTypeDef

def get_value() -> AssociateWebACLRequestRequestTypeDef:
    return {
        "WebACLArn": ...,
        "ResourceArn": ...,
    }

Definition

class AssociateWebACLRequestRequestTypeDef(TypedDict):
    WebACLArn: str,
    ResourceArn: str,

BodyTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import BodyTypeDef

def get_value() -> BodyTypeDef:
    return {
        "OversizeHandling": ...,
    }

Definition

class BodyTypeDef(TypedDict):
    OversizeHandling: NotRequired[OversizeHandlingType],  # (1)

1. See OversizeHandlingType

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)

1. See TextTransformationTypeType

ImmunityTimePropertyTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ImmunityTimePropertyTypeDef

def get_value() -> ImmunityTimePropertyTypeDef:
    return {
        "ImmunityTime": ...,
    }

Definition

class ImmunityTimePropertyTypeDef(TypedDict):
    ImmunityTime: int,

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)

1. See FailureReasonType

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)

1. See FailureReasonType

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": ...,
    }

Definition

class LabelNameConditionTypeDef(TypedDict):
    LabelName: str,

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": ...,
    }

Definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

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": ...,
    }

Definition

class RegexTypeDef(TypedDict):
    RegexString: NotRequired[str],

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,

1. See ResponseContentTypeType

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": ...,
    }

Definition

class CustomHTTPHeaderTypeDef(TypedDict):
    Name: str,
    Value: str,

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,

1. See ScopeType

DeleteLoggingConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import DeleteLoggingConfigurationRequestRequestTypeDef

def get_value() -> DeleteLoggingConfigurationRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

Definition

class DeleteLoggingConfigurationRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DeletePermissionPolicyRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import DeletePermissionPolicyRequestRequestTypeDef

def get_value() -> DeletePermissionPolicyRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

Definition

class DeletePermissionPolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

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,

1. 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,

1. 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,

1. 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],

1. See ScopeType

LabelSummaryTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import LabelSummaryTypeDef

def get_value() -> LabelSummaryTypeDef:
    return {
        "Name": ...,
    }

Definition

class LabelSummaryTypeDef(TypedDict):
    Name: NotRequired[str],

DisassociateWebACLRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import DisassociateWebACLRequestRequestTypeDef

def get_value() -> DisassociateWebACLRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

Definition

class DisassociateWebACLRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ExcludedRuleTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ExcludedRuleTypeDef

def get_value() -> ExcludedRuleTypeDef:
    return {
        "Name": ...,
    }

Definition

class ExcludedRuleTypeDef(TypedDict):
    Name: str,

SingleHeaderTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import SingleHeaderTypeDef

def get_value() -> SingleHeaderTypeDef:
    return {
        "Name": ...,
    }

Definition

class SingleHeaderTypeDef(TypedDict):
    Name: str,

SingleQueryArgumentTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import SingleQueryArgumentTypeDef

def get_value() -> SingleQueryArgumentTypeDef:
    return {
        "Name": ...,
    }

Definition

class SingleQueryArgumentTypeDef(TypedDict):
    Name: str,

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)

1. See FallbackBehaviorType

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,

1. 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,

1. 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],

1. See IPAddressVersionType

GetLoggingConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetLoggingConfigurationRequestRequestTypeDef

def get_value() -> GetLoggingConfigurationRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

Definition

class GetLoggingConfigurationRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

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,

1. 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,

1. See PlatformType

GetPermissionPolicyRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetPermissionPolicyRequestRequestTypeDef

def get_value() -> GetPermissionPolicyRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

Definition

class GetPermissionPolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

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],

1. 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]],

1. See IPAddressVersionType

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,

1. 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],

1. 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": ...,
    }

Definition

class GetWebACLForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

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,

1. See ScopeType

HTTPHeaderTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import HTTPHeaderTypeDef

def get_value() -> HTTPHeaderTypeDef:
    return {
        "Name": ...,
    }

Definition

class HTTPHeaderTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[str],

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)

1. See FallbackBehaviorType
2. See ForwardedIPPositionType

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": ...,
    }

Definition

class LabelMatchStatementTypeDef(TypedDict):
    Scope: LabelMatchScopeType,  # (1)
    Key: str,

1. See LabelMatchScopeType

LabelTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import LabelTypeDef

def get_value() -> LabelTypeDef:
    return {
        "Name": ...,
    }

Definition

class LabelTypeDef(TypedDict):
    Name: str,

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],

1. 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],

1. 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],

1. 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],

1. 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],

1. 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],

1. 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],

1. 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)

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],

1. 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],

1. See ScopeType

PasswordFieldTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import PasswordFieldTypeDef

def get_value() -> PasswordFieldTypeDef:
    return {
        "Identifier": ...,
    }

Definition

class PasswordFieldTypeDef(TypedDict):
    Identifier: str,

UsernameFieldTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import UsernameFieldTypeDef

def get_value() -> UsernameFieldTypeDef:
    return {
        "Identifier": ...,
    }

Definition

class UsernameFieldTypeDef(TypedDict):
    Identifier: str,

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": ...,
    }

Definition

class NotStatementTypeDef(TypedDict):
    Statement: StatementTypeDef,  # (1)

1. See StatementTypeDef

OrStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import OrStatementTypeDef

def get_value() -> OrStatementTypeDef:
    return {
        "Statements": ...,
    }

Definition

class OrStatementTypeDef(TypedDict):
    Statements: Sequence[StatementTypeDef],  # (1)

1. 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": ...,
    }

Definition

class PutPermissionPolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Policy: str,

ResponseInspectionBodyContainsTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ResponseInspectionBodyContainsTypeDef

def get_value() -> ResponseInspectionBodyContainsTypeDef:
    return {
        "SuccessStrings": ...,
        "FailureStrings": ...,
    }

Definition

class ResponseInspectionBodyContainsTypeDef(TypedDict):
    SuccessStrings: Sequence[str],
    FailureStrings: Sequence[str],

ResponseInspectionHeaderTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ResponseInspectionHeaderTypeDef

def get_value() -> ResponseInspectionHeaderTypeDef:
    return {
        "Name": ...,
        "SuccessValues": ...,
        "FailureValues": ...,
    }

Definition

class ResponseInspectionHeaderTypeDef(TypedDict):
    Name: str,
    SuccessValues: Sequence[str],
    FailureValues: Sequence[str],

ResponseInspectionJsonTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ResponseInspectionJsonTypeDef

def get_value() -> ResponseInspectionJsonTypeDef:
    return {
        "Identifier": ...,
        "SuccessValues": ...,
        "FailureValues": ...,
    }

Definition

class ResponseInspectionJsonTypeDef(TypedDict):
    Identifier: str,
    SuccessValues: Sequence[str],
    FailureValues: Sequence[str],

ResponseInspectionStatusCodeTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ResponseInspectionStatusCodeTypeDef

def get_value() -> ResponseInspectionStatusCodeTypeDef:
    return {
        "SuccessCodes": ...,
        "FailureCodes": ...,
    }

Definition

class ResponseInspectionStatusCodeTypeDef(TypedDict):
    SuccessCodes: Sequence[int],
    FailureCodes: Sequence[int],

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],

1. 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],

1. 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)

1. See ImmunityTimePropertyTypeDef

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)

1. See ImmunityTimePropertyTypeDef

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)

1. See ResponseMetadataTypeDef

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)

1. See ResponseMetadataTypeDef

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)

1. See ResponseMetadataTypeDef

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)

1. See ResponseMetadataTypeDef

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)

1. See ResponseMetadataTypeDef

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)

1. See ResponseMetadataTypeDef

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)

1. See ResponseMetadataTypeDef

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)

1. See ResponseMetadataTypeDef

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)

1. See ResponseMetadataTypeDef

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)

1. See ResponseMetadataTypeDef

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)

1. See ResponseMetadataTypeDef

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)

1. See ActionConditionTypeDef
2. See LabelNameConditionTypeDef

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)

1. See CookieMatchPatternTypeDef
2. See MapMatchScopeType
3. See OversizeHandlingType

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)

1. See ScopeType
2. See IPAddressVersionType
3. 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)

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)

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)

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)

1. See IPSetSummaryTypeDef
2. See ResponseMetadataTypeDef

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)

1. See IPSetSummaryTypeDef
2. See ResponseMetadataTypeDef

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)

1. See ScopeType
2. See RegexTypeDef
3. 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)

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],

1. See ScopeType
2. 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)

1. See RegexPatternSetSummaryTypeDef
2. See ResponseMetadataTypeDef

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)

1. See RegexPatternSetSummaryTypeDef
2. See ResponseMetadataTypeDef

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)

1. See RuleGroupSummaryTypeDef
2. See ResponseMetadataTypeDef

ListRuleGroupsResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ListRuleGroupsResponseTypeDef

def get_value() -> ListRuleGroupsResponseTypeDef:
    return {
        "NextMarker": ...,
        "RuleGroups": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListRuleGroupsResponseTypeDef(TypedDict):
    NextMarker: str,
    RuleGroups: List[RuleGroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RuleGroupSummaryTypeDef
2. See ResponseMetadataTypeDef

CreateWebACLResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import CreateWebACLResponseTypeDef

def get_value() -> CreateWebACLResponseTypeDef:
    return {
        "Summary": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateWebACLResponseTypeDef(TypedDict):
    Summary: WebACLSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See WebACLSummaryTypeDef
2. See ResponseMetadataTypeDef

ListWebACLsResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ListWebACLsResponseTypeDef

def get_value() -> ListWebACLsResponseTypeDef:
    return {
        "NextMarker": ...,
        "WebACLs": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListWebACLsResponseTypeDef(TypedDict):
    NextMarker: str,
    WebACLs: List[WebACLSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See WebACLSummaryTypeDef
2. See ResponseMetadataTypeDef

CustomRequestHandlingTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import CustomRequestHandlingTypeDef

def get_value() -> CustomRequestHandlingTypeDef:
    return {
        "InsertHeaders": ...,
    }

Definition

class CustomRequestHandlingTypeDef(TypedDict):
    InsertHeaders: Sequence[CustomHTTPHeaderTypeDef],  # (1)

1. See CustomHTTPHeaderTypeDef

CustomResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import CustomResponseTypeDef

def get_value() -> CustomResponseTypeDef:
    return {
        "ResponseCode": ...,
    }

Definition

class CustomResponseTypeDef(TypedDict):
    ResponseCode: int,
    CustomResponseBodyKey: NotRequired[str],
    ResponseHeaders: NotRequired[Sequence[CustomHTTPHeaderTypeDef]],  # (1)

1. See CustomHTTPHeaderTypeDef

GeoMatchStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GeoMatchStatementTypeDef

def get_value() -> GeoMatchStatementTypeDef:
    return {
        "CountryCodes": ...,
    }

Definition

class GeoMatchStatementTypeDef(TypedDict):
    CountryCodes: NotRequired[Sequence[CountryCodeType]],  # (1)
    ForwardedIPConfig: NotRequired[ForwardedIPConfigTypeDef],  # (2)

1. See CountryCodeType
2. See ForwardedIPConfigTypeDef

RateBasedStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import RateBasedStatementTypeDef

def get_value() -> RateBasedStatementTypeDef:
    return {
        "Limit": ...,
        "AggregateKeyType": ...,
    }

Definition

class RateBasedStatementTypeDef(TypedDict):
    Limit: int,
    AggregateKeyType: RateBasedStatementAggregateKeyTypeType,  # (1)
    ScopeDownStatement: NotRequired[StatementTypeDef],  # (2)
    ForwardedIPConfig: NotRequired[ForwardedIPConfigTypeDef],  # (3)

1. See RateBasedStatementAggregateKeyTypeType
2. See StatementTypeDef
3. See ForwardedIPConfigTypeDef

GetIPSetResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetIPSetResponseTypeDef

def get_value() -> GetIPSetResponseTypeDef:
    return {
        "IPSet": ...,
        "LockToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetIPSetResponseTypeDef(TypedDict):
    IPSet: IPSetTypeDef,  # (1)
    LockToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See IPSetTypeDef
2. See ResponseMetadataTypeDef

GetRateBasedStatementManagedKeysResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetRateBasedStatementManagedKeysResponseTypeDef

def get_value() -> GetRateBasedStatementManagedKeysResponseTypeDef:
    return {
        "ManagedKeysIPV4": ...,
        "ManagedKeysIPV6": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetRateBasedStatementManagedKeysResponseTypeDef(TypedDict):
    ManagedKeysIPV4: RateBasedStatementManagedKeysIPSetTypeDef,  # (1)
    ManagedKeysIPV6: RateBasedStatementManagedKeysIPSetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See RateBasedStatementManagedKeysIPSetTypeDef
2. See RateBasedStatementManagedKeysIPSetTypeDef
3. See ResponseMetadataTypeDef

GetSampledRequestsRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetSampledRequestsRequestRequestTypeDef

def get_value() -> GetSampledRequestsRequestRequestTypeDef:
    return {
        "WebAclArn": ...,
        "RuleMetricName": ...,
        "Scope": ...,
        "TimeWindow": ...,
        "MaxItems": ...,
    }

Definition

class GetSampledRequestsRequestRequestTypeDef(TypedDict):
    WebAclArn: str,
    RuleMetricName: str,
    Scope: ScopeType,  # (1)
    TimeWindow: TimeWindowTypeDef,  # (2)
    MaxItems: int,

1. See ScopeType
2. See TimeWindowTypeDef

HTTPRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import HTTPRequestTypeDef

def get_value() -> HTTPRequestTypeDef:
    return {
        "ClientIP": ...,
    }

Definition

class HTTPRequestTypeDef(TypedDict):
    ClientIP: NotRequired[str],
    Country: NotRequired[str],
    URI: NotRequired[str],
    Method: NotRequired[str],
    HTTPVersion: NotRequired[str],
    Headers: NotRequired[List[HTTPHeaderTypeDef]],  # (1)

1. See HTTPHeaderTypeDef

HeadersTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import HeadersTypeDef

def get_value() -> HeadersTypeDef:
    return {
        "MatchPattern": ...,
        "MatchScope": ...,
        "OversizeHandling": ...,
    }

Definition

class HeadersTypeDef(TypedDict):
    MatchPattern: HeaderMatchPatternTypeDef,  # (1)
    MatchScope: MapMatchScopeType,  # (2)
    OversizeHandling: OversizeHandlingType,  # (3)

1. See HeaderMatchPatternTypeDef
2. See MapMatchScopeType
3. See OversizeHandlingType

IPSetReferenceStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import IPSetReferenceStatementTypeDef

def get_value() -> IPSetReferenceStatementTypeDef:
    return {
        "ARN": ...,
    }

Definition

class IPSetReferenceStatementTypeDef(TypedDict):
    ARN: str,
    IPSetForwardedIPConfig: NotRequired[IPSetForwardedIPConfigTypeDef],  # (1)

1. See IPSetForwardedIPConfigTypeDef

JsonBodyTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import JsonBodyTypeDef

def get_value() -> JsonBodyTypeDef:
    return {
        "MatchPattern": ...,
        "MatchScope": ...,
    }

Definition

class JsonBodyTypeDef(TypedDict):
    MatchPattern: JsonMatchPatternTypeDef,  # (1)
    MatchScope: JsonMatchScopeType,  # (2)
    InvalidFallbackBehavior: NotRequired[BodyParsingFallbackBehaviorType],  # (3)
    OversizeHandling: NotRequired[OversizeHandlingType],  # (4)

1. See JsonMatchPatternTypeDef
2. See JsonMatchScopeType
3. See BodyParsingFallbackBehaviorType
4. See OversizeHandlingType

ListAvailableManagedRuleGroupVersionsResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ListAvailableManagedRuleGroupVersionsResponseTypeDef

def get_value() -> ListAvailableManagedRuleGroupVersionsResponseTypeDef:
    return {
        "NextMarker": ...,
        "Versions": ...,
        "CurrentDefaultVersion": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListAvailableManagedRuleGroupVersionsResponseTypeDef(TypedDict):
    NextMarker: str,
    Versions: List[ManagedRuleGroupVersionTypeDef],  # (1)
    CurrentDefaultVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ManagedRuleGroupVersionTypeDef
2. See ResponseMetadataTypeDef

ListAvailableManagedRuleGroupsResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ListAvailableManagedRuleGroupsResponseTypeDef

def get_value() -> ListAvailableManagedRuleGroupsResponseTypeDef:
    return {
        "NextMarker": ...,
        "ManagedRuleGroups": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListAvailableManagedRuleGroupsResponseTypeDef(TypedDict):
    NextMarker: str,
    ManagedRuleGroups: List[ManagedRuleGroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ManagedRuleGroupSummaryTypeDef
2. See ResponseMetadataTypeDef

ListManagedRuleSetsResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ListManagedRuleSetsResponseTypeDef

def get_value() -> ListManagedRuleSetsResponseTypeDef:
    return {
        "NextMarker": ...,
        "ManagedRuleSets": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListManagedRuleSetsResponseTypeDef(TypedDict):
    NextMarker: str,
    ManagedRuleSets: List[ManagedRuleSetSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ManagedRuleSetSummaryTypeDef
2. See ResponseMetadataTypeDef

ListMobileSdkReleasesResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ListMobileSdkReleasesResponseTypeDef

def get_value() -> ListMobileSdkReleasesResponseTypeDef:
    return {
        "ReleaseSummaries": ...,
        "NextMarker": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListMobileSdkReleasesResponseTypeDef(TypedDict):
    ReleaseSummaries: List[ReleaseSummaryTypeDef],  # (1)
    NextMarker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ReleaseSummaryTypeDef
2. See ResponseMetadataTypeDef

RequestInspectionTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import RequestInspectionTypeDef

def get_value() -> RequestInspectionTypeDef:
    return {
        "PayloadType": ...,
        "UsernameField": ...,
        "PasswordField": ...,
    }

Definition

class RequestInspectionTypeDef(TypedDict):
    PayloadType: PayloadTypeType,  # (1)
    UsernameField: UsernameFieldTypeDef,  # (2)
    PasswordField: PasswordFieldTypeDef,  # (3)

1. See PayloadTypeType
2. See UsernameFieldTypeDef
3. See PasswordFieldTypeDef

ManagedRuleSetTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ManagedRuleSetTypeDef

def get_value() -> ManagedRuleSetTypeDef:
    return {
        "Name": ...,
        "Id": ...,
        "ARN": ...,
    }

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],

1. See ManagedRuleSetVersionTypeDef

PutManagedRuleSetVersionsRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import PutManagedRuleSetVersionsRequestRequestTypeDef

def get_value() -> PutManagedRuleSetVersionsRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
        "LockToken": ...,
    }

Definition

class PutManagedRuleSetVersionsRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
    RecommendedVersion: NotRequired[str],
    VersionsToPublish: NotRequired[Mapping[str, VersionToPublishTypeDef]],  # (2)

1. See ScopeType
2. See VersionToPublishTypeDef

ResponseInspectionTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ResponseInspectionTypeDef

def get_value() -> ResponseInspectionTypeDef:
    return {
        "StatusCode": ...,
    }

Definition

class ResponseInspectionTypeDef(TypedDict):
    StatusCode: NotRequired[ResponseInspectionStatusCodeTypeDef],  # (1)
    Header: NotRequired[ResponseInspectionHeaderTypeDef],  # (2)
    BodyContains: NotRequired[ResponseInspectionBodyContainsTypeDef],  # (3)
    Json: NotRequired[ResponseInspectionJsonTypeDef],  # (4)

1. See ResponseInspectionStatusCodeTypeDef
2. See ResponseInspectionHeaderTypeDef
3. See ResponseInspectionBodyContainsTypeDef
4. See ResponseInspectionJsonTypeDef

FilterTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import FilterTypeDef

def get_value() -> FilterTypeDef:
    return {
        "Behavior": ...,
        "Requirement": ...,
        "Conditions": ...,
    }

Definition

class FilterTypeDef(TypedDict):
    Behavior: FilterBehaviorType,  # (1)
    Requirement: FilterRequirementType,  # (2)
    Conditions: List[ConditionTypeDef],  # (3)

1. See FilterBehaviorType
2. See FilterRequirementType
3. See ConditionTypeDef

GetMobileSdkReleaseResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetMobileSdkReleaseResponseTypeDef

def get_value() -> GetMobileSdkReleaseResponseTypeDef:
    return {
        "MobileSdkRelease": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetMobileSdkReleaseResponseTypeDef(TypedDict):
    MobileSdkRelease: MobileSdkReleaseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MobileSdkReleaseTypeDef
2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "NextMarker": ...,
        "TagInfoForResource": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    NextMarker: str,
    TagInfoForResource: TagInfoForResourceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TagInfoForResourceTypeDef
2. See ResponseMetadataTypeDef

GetRegexPatternSetResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetRegexPatternSetResponseTypeDef

def get_value() -> GetRegexPatternSetResponseTypeDef:
    return {
        "RegexPatternSet": ...,
        "LockToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetRegexPatternSetResponseTypeDef(TypedDict):
    RegexPatternSet: RegexPatternSetTypeDef,  # (1)
    LockToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RegexPatternSetTypeDef
2. See ResponseMetadataTypeDef

AllowActionTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import AllowActionTypeDef

def get_value() -> AllowActionTypeDef:
    return {
        "CustomRequestHandling": ...,
    }

Definition

class AllowActionTypeDef(TypedDict):
    CustomRequestHandling: NotRequired[CustomRequestHandlingTypeDef],  # (1)

1. See CustomRequestHandlingTypeDef

CaptchaActionTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import CaptchaActionTypeDef

def get_value() -> CaptchaActionTypeDef:
    return {
        "CustomRequestHandling": ...,
    }

Definition

class CaptchaActionTypeDef(TypedDict):
    CustomRequestHandling: NotRequired[CustomRequestHandlingTypeDef],  # (1)

1. See CustomRequestHandlingTypeDef

ChallengeActionTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ChallengeActionTypeDef

def get_value() -> ChallengeActionTypeDef:
    return {
        "CustomRequestHandling": ...,
    }

Definition

class ChallengeActionTypeDef(TypedDict):
    CustomRequestHandling: NotRequired[CustomRequestHandlingTypeDef],  # (1)

1. See CustomRequestHandlingTypeDef

CountActionTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import CountActionTypeDef

def get_value() -> CountActionTypeDef:
    return {
        "CustomRequestHandling": ...,
    }

Definition

class CountActionTypeDef(TypedDict):
    CustomRequestHandling: NotRequired[CustomRequestHandlingTypeDef],  # (1)

1. See CustomRequestHandlingTypeDef

BlockActionTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import BlockActionTypeDef

def get_value() -> BlockActionTypeDef:
    return {
        "CustomResponse": ...,
    }

Definition

class BlockActionTypeDef(TypedDict):
    CustomResponse: NotRequired[CustomResponseTypeDef],  # (1)

1. See CustomResponseTypeDef

SampledHTTPRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import SampledHTTPRequestTypeDef

def get_value() -> SampledHTTPRequestTypeDef:
    return {
        "Request": ...,
        "Weight": ...,
    }

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],

1. See HTTPRequestTypeDef
2. See HTTPHeaderTypeDef
3. See LabelTypeDef
4. See CaptchaResponseTypeDef
5. See ChallengeResponseTypeDef

FieldToMatchTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import FieldToMatchTypeDef

def get_value() -> FieldToMatchTypeDef:
    return {
        "SingleHeader": ...,
    }

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[JsonBodyTypeDef],  # (4)
    Headers: NotRequired[HeadersTypeDef],  # (5)
    Cookies: NotRequired[CookiesTypeDef],  # (6)

1. See SingleHeaderTypeDef
2. See SingleQueryArgumentTypeDef
3. See BodyTypeDef
4. See JsonBodyTypeDef
5. See HeadersTypeDef
6. See CookiesTypeDef

GetManagedRuleSetResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetManagedRuleSetResponseTypeDef

def get_value() -> GetManagedRuleSetResponseTypeDef:
    return {
        "ManagedRuleSet": ...,
        "LockToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetManagedRuleSetResponseTypeDef(TypedDict):
    ManagedRuleSet: ManagedRuleSetTypeDef,  # (1)
    LockToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ManagedRuleSetTypeDef
2. See ResponseMetadataTypeDef

AWSManagedRulesATPRuleSetTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import AWSManagedRulesATPRuleSetTypeDef

def get_value() -> AWSManagedRulesATPRuleSetTypeDef:
    return {
        "LoginPath": ...,
    }

Definition

class AWSManagedRulesATPRuleSetTypeDef(TypedDict):
    LoginPath: str,
    RequestInspection: NotRequired[RequestInspectionTypeDef],  # (1)
    ResponseInspection: NotRequired[ResponseInspectionTypeDef],  # (2)

1. See RequestInspectionTypeDef
2. See ResponseInspectionTypeDef

LoggingFilterTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import LoggingFilterTypeDef

def get_value() -> LoggingFilterTypeDef:
    return {
        "Filters": ...,
        "DefaultBehavior": ...,
    }

Definition

class LoggingFilterTypeDef(TypedDict):
    Filters: List[FilterTypeDef],  # (1)
    DefaultBehavior: FilterBehaviorType,  # (2)

1. See FilterTypeDef
2. See FilterBehaviorType

OverrideActionTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import OverrideActionTypeDef

def get_value() -> OverrideActionTypeDef:
    return {
        "Count": ...,
    }

Definition

class OverrideActionTypeDef(TypedDict):
    Count: NotRequired[CountActionTypeDef],  # (1)
    None: NotRequired[Mapping[str, Any]],

1. See CountActionTypeDef

DefaultActionTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import DefaultActionTypeDef

def get_value() -> DefaultActionTypeDef:
    return {
        "Block": ...,
    }

Definition

class DefaultActionTypeDef(TypedDict):
    Block: NotRequired[BlockActionTypeDef],  # (1)
    Allow: NotRequired[AllowActionTypeDef],  # (2)

1. See BlockActionTypeDef
2. See AllowActionTypeDef

RuleActionTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import RuleActionTypeDef

def get_value() -> RuleActionTypeDef:
    return {
        "Block": ...,
    }

Definition

class RuleActionTypeDef(TypedDict):
    Block: NotRequired[BlockActionTypeDef],  # (1)
    Allow: NotRequired[AllowActionTypeDef],  # (2)
    Count: NotRequired[CountActionTypeDef],  # (3)
    Captcha: NotRequired[CaptchaActionTypeDef],  # (4)
    Challenge: NotRequired[ChallengeActionTypeDef],  # (5)

1. See BlockActionTypeDef
2. See AllowActionTypeDef
3. See CountActionTypeDef
4. See CaptchaActionTypeDef
5. See ChallengeActionTypeDef

GetSampledRequestsResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetSampledRequestsResponseTypeDef

def get_value() -> GetSampledRequestsResponseTypeDef:
    return {
        "SampledRequests": ...,
        "PopulationSize": ...,
        "TimeWindow": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetSampledRequestsResponseTypeDef(TypedDict):
    SampledRequests: List[SampledHTTPRequestTypeDef],  # (1)
    PopulationSize: int,
    TimeWindow: TimeWindowTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See SampledHTTPRequestTypeDef
2. See TimeWindowTypeDef
3. See ResponseMetadataTypeDef

ByteMatchStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ByteMatchStatementTypeDef

def get_value() -> ByteMatchStatementTypeDef:
    return {
        "SearchString": ...,
        "FieldToMatch": ...,
        "TextTransformations": ...,
        "PositionalConstraint": ...,
    }

Definition

class ByteMatchStatementTypeDef(TypedDict):
    SearchString: Union[str, bytes, IO[Any], StreamingBody],
    FieldToMatch: FieldToMatchTypeDef,  # (1)
    TextTransformations: Sequence[TextTransformationTypeDef],  # (2)
    PositionalConstraint: PositionalConstraintType,  # (3)

1. See FieldToMatchTypeDef
2. See TextTransformationTypeDef
3. See PositionalConstraintType

RegexMatchStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import RegexMatchStatementTypeDef

def get_value() -> RegexMatchStatementTypeDef:
    return {
        "RegexString": ...,
        "FieldToMatch": ...,
        "TextTransformations": ...,
    }

Definition

class RegexMatchStatementTypeDef(TypedDict):
    RegexString: str,
    FieldToMatch: FieldToMatchTypeDef,  # (1)
    TextTransformations: Sequence[TextTransformationTypeDef],  # (2)

1. See FieldToMatchTypeDef
2. See TextTransformationTypeDef

RegexPatternSetReferenceStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import RegexPatternSetReferenceStatementTypeDef

def get_value() -> RegexPatternSetReferenceStatementTypeDef:
    return {
        "ARN": ...,
        "FieldToMatch": ...,
        "TextTransformations": ...,
    }

Definition

class RegexPatternSetReferenceStatementTypeDef(TypedDict):
    ARN: str,
    FieldToMatch: FieldToMatchTypeDef,  # (1)
    TextTransformations: Sequence[TextTransformationTypeDef],  # (2)

1. See FieldToMatchTypeDef
2. See TextTransformationTypeDef

SizeConstraintStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import SizeConstraintStatementTypeDef

def get_value() -> SizeConstraintStatementTypeDef:
    return {
        "FieldToMatch": ...,
        "ComparisonOperator": ...,
        "Size": ...,
        "TextTransformations": ...,
    }

Definition

class SizeConstraintStatementTypeDef(TypedDict):
    FieldToMatch: FieldToMatchTypeDef,  # (1)
    ComparisonOperator: ComparisonOperatorType,  # (2)
    Size: int,
    TextTransformations: Sequence[TextTransformationTypeDef],  # (3)

1. See FieldToMatchTypeDef
2. See ComparisonOperatorType
3. See TextTransformationTypeDef

SqliMatchStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import SqliMatchStatementTypeDef

def get_value() -> SqliMatchStatementTypeDef:
    return {
        "FieldToMatch": ...,
        "TextTransformations": ...,
    }

Definition

class SqliMatchStatementTypeDef(TypedDict):
    FieldToMatch: FieldToMatchTypeDef,  # (1)
    TextTransformations: Sequence[TextTransformationTypeDef],  # (2)
    SensitivityLevel: NotRequired[SensitivityLevelType],  # (3)

1. See FieldToMatchTypeDef
2. See TextTransformationTypeDef
3. See SensitivityLevelType

XssMatchStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import XssMatchStatementTypeDef

def get_value() -> XssMatchStatementTypeDef:
    return {
        "FieldToMatch": ...,
        "TextTransformations": ...,
    }

Definition

class XssMatchStatementTypeDef(TypedDict):
    FieldToMatch: FieldToMatchTypeDef,  # (1)
    TextTransformations: Sequence[TextTransformationTypeDef],  # (2)

1. See FieldToMatchTypeDef
2. See TextTransformationTypeDef

ManagedRuleGroupConfigTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ManagedRuleGroupConfigTypeDef

def get_value() -> ManagedRuleGroupConfigTypeDef:
    return {
        "LoginPath": ...,
    }

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[AWSManagedRulesATPRuleSetTypeDef],  # (5)

1. See PayloadTypeType
2. See UsernameFieldTypeDef
3. See PasswordFieldTypeDef
4. See AWSManagedRulesBotControlRuleSetTypeDef
5. See AWSManagedRulesATPRuleSetTypeDef

LoggingConfigurationTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import LoggingConfigurationTypeDef

def get_value() -> LoggingConfigurationTypeDef:
    return {
        "ResourceArn": ...,
        "LogDestinationConfigs": ...,
    }

Definition

class LoggingConfigurationTypeDef(TypedDict):
    ResourceArn: str,
    LogDestinationConfigs: List[str],
    RedactedFields: NotRequired[List[FieldToMatchTypeDef]],  # (1)
    ManagedByFirewallManager: NotRequired[bool],
    LoggingFilter: NotRequired[LoggingFilterTypeDef],  # (2)

1. See FieldToMatchTypeDef
2. See LoggingFilterTypeDef

RuleActionOverrideTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import RuleActionOverrideTypeDef

def get_value() -> RuleActionOverrideTypeDef:
    return {
        "Name": ...,
        "ActionToUse": ...,
    }

Definition

class RuleActionOverrideTypeDef(TypedDict):
    Name: str,
    ActionToUse: RuleActionTypeDef,  # (1)

1. See RuleActionTypeDef

RuleSummaryTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import RuleSummaryTypeDef

def get_value() -> RuleSummaryTypeDef:
    return {
        "Name": ...,
    }

Definition

class RuleSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    Action: NotRequired[RuleActionTypeDef],  # (1)

1. See RuleActionTypeDef

RuleTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import RuleTypeDef

def get_value() -> RuleTypeDef:
    return {
        "Name": ...,
        "Priority": ...,
        "Statement": ...,
        "VisibilityConfig": ...,
    }

Definition

class RuleTypeDef(TypedDict):
    Name: str,
    Priority: int,
    Statement: StatementTypeDef,  # (1)
    VisibilityConfig: VisibilityConfigTypeDef,  # (5)
    Action: NotRequired[RuleActionTypeDef],  # (2)
    OverrideAction: NotRequired[OverrideActionTypeDef],  # (3)
    RuleLabels: NotRequired[Sequence[LabelTypeDef]],  # (4)
    CaptchaConfig: NotRequired[CaptchaConfigTypeDef],  # (6)
    ChallengeConfig: NotRequired[ChallengeConfigTypeDef],  # (7)

1. See StatementTypeDef
2. See RuleActionTypeDef
3. See OverrideActionTypeDef
4. See LabelTypeDef
5. See VisibilityConfigTypeDef
6. See CaptchaConfigTypeDef
7. See ChallengeConfigTypeDef

GetLoggingConfigurationResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetLoggingConfigurationResponseTypeDef

def get_value() -> GetLoggingConfigurationResponseTypeDef:
    return {
        "LoggingConfiguration": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetLoggingConfigurationResponseTypeDef(TypedDict):
    LoggingConfiguration: LoggingConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LoggingConfigurationTypeDef
2. See ResponseMetadataTypeDef

ListLoggingConfigurationsResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ListLoggingConfigurationsResponseTypeDef

def get_value() -> ListLoggingConfigurationsResponseTypeDef:
    return {
        "LoggingConfigurations": ...,
        "NextMarker": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListLoggingConfigurationsResponseTypeDef(TypedDict):
    LoggingConfigurations: List[LoggingConfigurationTypeDef],  # (1)
    NextMarker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LoggingConfigurationTypeDef
2. See ResponseMetadataTypeDef

PutLoggingConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import PutLoggingConfigurationRequestRequestTypeDef

def get_value() -> PutLoggingConfigurationRequestRequestTypeDef:
    return {
        "LoggingConfiguration": ...,
    }

Definition

class PutLoggingConfigurationRequestRequestTypeDef(TypedDict):
    LoggingConfiguration: LoggingConfigurationTypeDef,  # (1)

1. See LoggingConfigurationTypeDef

PutLoggingConfigurationResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import PutLoggingConfigurationResponseTypeDef

def get_value() -> PutLoggingConfigurationResponseTypeDef:
    return {
        "LoggingConfiguration": ...,
        "ResponseMetadata": ...,
    }

Definition

class PutLoggingConfigurationResponseTypeDef(TypedDict):
    LoggingConfiguration: LoggingConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LoggingConfigurationTypeDef
2. See ResponseMetadataTypeDef

ManagedRuleGroupStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import ManagedRuleGroupStatementTypeDef

def get_value() -> ManagedRuleGroupStatementTypeDef:
    return {
        "VendorName": ...,
        "Name": ...,
    }

Definition

class ManagedRuleGroupStatementTypeDef(TypedDict):
    VendorName: str,
    Name: str,
    Version: NotRequired[str],
    ExcludedRules: NotRequired[Sequence[ExcludedRuleTypeDef]],  # (1)
    ScopeDownStatement: NotRequired[StatementTypeDef],  # (2)
    ManagedRuleGroupConfigs: NotRequired[Sequence[ManagedRuleGroupConfigTypeDef]],  # (3)
    RuleActionOverrides: NotRequired[Sequence[RuleActionOverrideTypeDef]],  # (4)

1. See ExcludedRuleTypeDef
2. See StatementTypeDef
3. See ManagedRuleGroupConfigTypeDef
4. See RuleActionOverrideTypeDef

RuleGroupReferenceStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import RuleGroupReferenceStatementTypeDef

def get_value() -> RuleGroupReferenceStatementTypeDef:
    return {
        "ARN": ...,
    }

Definition

class RuleGroupReferenceStatementTypeDef(TypedDict):
    ARN: str,
    ExcludedRules: NotRequired[Sequence[ExcludedRuleTypeDef]],  # (1)
    RuleActionOverrides: NotRequired[Sequence[RuleActionOverrideTypeDef]],  # (2)

1. See ExcludedRuleTypeDef
2. See RuleActionOverrideTypeDef

DescribeManagedRuleGroupResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import DescribeManagedRuleGroupResponseTypeDef

def get_value() -> DescribeManagedRuleGroupResponseTypeDef:
    return {
        "VersionName": ...,
        "SnsTopicArn": ...,
        "Capacity": ...,
        "Rules": ...,
        "LabelNamespace": ...,
        "AvailableLabels": ...,
        "ConsumedLabels": ...,
        "ResponseMetadata": ...,
    }

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)

1. See RuleSummaryTypeDef
2. See LabelSummaryTypeDef
3. See LabelSummaryTypeDef
4. See ResponseMetadataTypeDef

CheckCapacityRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import CheckCapacityRequestRequestTypeDef

def get_value() -> CheckCapacityRequestRequestTypeDef:
    return {
        "Scope": ...,
        "Rules": ...,
    }

Definition

class CheckCapacityRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
    Rules: Sequence[RuleTypeDef],  # (2)

1. See ScopeType
2. See RuleTypeDef

CreateRuleGroupRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import CreateRuleGroupRequestRequestTypeDef

def get_value() -> CreateRuleGroupRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Capacity": ...,
        "VisibilityConfig": ...,
    }

Definition

class CreateRuleGroupRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Capacity: int,
    VisibilityConfig: VisibilityConfigTypeDef,  # (2)
    Description: NotRequired[str],
    Rules: NotRequired[Sequence[RuleTypeDef]],  # (3)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
    CustomResponseBodies: NotRequired[Mapping[str, CustomResponseBodyTypeDef]],  # (5)

1. See ScopeType
2. See VisibilityConfigTypeDef
3. See RuleTypeDef
4. See TagTypeDef
5. See CustomResponseBodyTypeDef

CreateWebACLRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import CreateWebACLRequestRequestTypeDef

def get_value() -> CreateWebACLRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "DefaultAction": ...,
        "VisibilityConfig": ...,
    }

Definition

class CreateWebACLRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    DefaultAction: DefaultActionTypeDef,  # (2)
    VisibilityConfig: VisibilityConfigTypeDef,  # (3)
    Description: NotRequired[str],
    Rules: NotRequired[Sequence[RuleTypeDef]],  # (4)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (5)
    CustomResponseBodies: NotRequired[Mapping[str, CustomResponseBodyTypeDef]],  # (6)
    CaptchaConfig: NotRequired[CaptchaConfigTypeDef],  # (7)
    ChallengeConfig: NotRequired[ChallengeConfigTypeDef],  # (8)
    TokenDomains: NotRequired[Sequence[str]],

1. See ScopeType
2. See DefaultActionTypeDef
3. See VisibilityConfigTypeDef
4. See RuleTypeDef
5. See TagTypeDef
6. See CustomResponseBodyTypeDef
7. See CaptchaConfigTypeDef
8. See ChallengeConfigTypeDef

RuleGroupTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import RuleGroupTypeDef

def get_value() -> RuleGroupTypeDef:
    return {
        "Name": ...,
        "Id": ...,
        "Capacity": ...,
        "ARN": ...,
        "VisibilityConfig": ...,
    }

Definition

class RuleGroupTypeDef(TypedDict):
    Name: str,
    Id: str,
    Capacity: int,
    ARN: str,
    VisibilityConfig: VisibilityConfigTypeDef,  # (2)
    Description: NotRequired[str],
    Rules: NotRequired[List[RuleTypeDef]],  # (1)
    LabelNamespace: NotRequired[str],
    CustomResponseBodies: NotRequired[Dict[str, CustomResponseBodyTypeDef]],  # (3)
    AvailableLabels: NotRequired[List[LabelSummaryTypeDef]],  # (4)
    ConsumedLabels: NotRequired[List[LabelSummaryTypeDef]],  # (4)

1. See RuleTypeDef
2. See VisibilityConfigTypeDef
3. See CustomResponseBodyTypeDef
4. See LabelSummaryTypeDef
5. See LabelSummaryTypeDef

UpdateRuleGroupRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import UpdateRuleGroupRequestRequestTypeDef

def get_value() -> UpdateRuleGroupRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
        "VisibilityConfig": ...,
        "LockToken": ...,
    }

Definition

class UpdateRuleGroupRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    VisibilityConfig: VisibilityConfigTypeDef,  # (2)
    LockToken: str,
    Description: NotRequired[str],
    Rules: NotRequired[Sequence[RuleTypeDef]],  # (3)
    CustomResponseBodies: NotRequired[Mapping[str, CustomResponseBodyTypeDef]],  # (4)

1. See ScopeType
2. See VisibilityConfigTypeDef
3. See RuleTypeDef
4. See CustomResponseBodyTypeDef

UpdateWebACLRequestRequestTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import UpdateWebACLRequestRequestTypeDef

def get_value() -> UpdateWebACLRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
        "DefaultAction": ...,
        "VisibilityConfig": ...,
        "LockToken": ...,
    }

Definition

class UpdateWebACLRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    DefaultAction: DefaultActionTypeDef,  # (2)
    VisibilityConfig: VisibilityConfigTypeDef,  # (3)
    LockToken: str,
    Description: NotRequired[str],
    Rules: NotRequired[Sequence[RuleTypeDef]],  # (4)
    CustomResponseBodies: NotRequired[Mapping[str, CustomResponseBodyTypeDef]],  # (5)
    CaptchaConfig: NotRequired[CaptchaConfigTypeDef],  # (6)
    ChallengeConfig: NotRequired[ChallengeConfigTypeDef],  # (7)
    TokenDomains: NotRequired[Sequence[str]],

1. See ScopeType
2. See DefaultActionTypeDef
3. See VisibilityConfigTypeDef
4. See RuleTypeDef
5. See CustomResponseBodyTypeDef
6. See CaptchaConfigTypeDef
7. See ChallengeConfigTypeDef

FirewallManagerStatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import FirewallManagerStatementTypeDef

def get_value() -> FirewallManagerStatementTypeDef:
    return {
        "ManagedRuleGroupStatement": ...,
    }

Definition

class FirewallManagerStatementTypeDef(TypedDict):
    ManagedRuleGroupStatement: NotRequired[ManagedRuleGroupStatementTypeDef],  # (1)
    RuleGroupReferenceStatement: NotRequired[RuleGroupReferenceStatementTypeDef],  # (2)

1. See ManagedRuleGroupStatementTypeDef
2. See RuleGroupReferenceStatementTypeDef

StatementTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import StatementTypeDef

def get_value() -> StatementTypeDef:
    return {
        "ByteMatchStatement": ...,
    }

Definition

class StatementTypeDef(TypedDict):
    ByteMatchStatement: NotRequired[ByteMatchStatementTypeDef],  # (1)
    SqliMatchStatement: NotRequired[SqliMatchStatementTypeDef],  # (2)
    XssMatchStatement: NotRequired[XssMatchStatementTypeDef],  # (3)
    SizeConstraintStatement: NotRequired[SizeConstraintStatementTypeDef],  # (4)
    GeoMatchStatement: NotRequired[GeoMatchStatementTypeDef],  # (5)
    RuleGroupReferenceStatement: NotRequired[RuleGroupReferenceStatementTypeDef],  # (6)
    IPSetReferenceStatement: NotRequired[IPSetReferenceStatementTypeDef],  # (7)
    RegexPatternSetReferenceStatement: NotRequired[RegexPatternSetReferenceStatementTypeDef],  # (8)
    RateBasedStatement: NotRequired[RateBasedStatementTypeDef],  # (9)
    AndStatement: NotRequired[AndStatementTypeDef],  # (10)
    OrStatement: NotRequired[OrStatementTypeDef],  # (11)
    NotStatement: NotRequired[NotStatementTypeDef],  # (12)
    ManagedRuleGroupStatement: NotRequired[ManagedRuleGroupStatementTypeDef],  # (13)
    LabelMatchStatement: NotRequired[LabelMatchStatementTypeDef],  # (14)
    RegexMatchStatement: NotRequired[RegexMatchStatementTypeDef],  # (15)

1. See ByteMatchStatementTypeDef
2. See SqliMatchStatementTypeDef
3. See XssMatchStatementTypeDef
4. See SizeConstraintStatementTypeDef
5. See GeoMatchStatementTypeDef
6. See RuleGroupReferenceStatementTypeDef
7. See IPSetReferenceStatementTypeDef
8. See RegexPatternSetReferenceStatementTypeDef
9. See RateBasedStatementTypeDef
10. See AndStatementTypeDef
11. See OrStatementTypeDef
12. See NotStatementTypeDef
13. See ManagedRuleGroupStatementTypeDef
14. See LabelMatchStatementTypeDef
15. See RegexMatchStatementTypeDef

GetRuleGroupResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetRuleGroupResponseTypeDef

def get_value() -> GetRuleGroupResponseTypeDef:
    return {
        "RuleGroup": ...,
        "LockToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetRuleGroupResponseTypeDef(TypedDict):
    RuleGroup: RuleGroupTypeDef,  # (1)
    LockToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RuleGroupTypeDef
2. See ResponseMetadataTypeDef

FirewallManagerRuleGroupTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import FirewallManagerRuleGroupTypeDef

def get_value() -> FirewallManagerRuleGroupTypeDef:
    return {
        "Name": ...,
        "Priority": ...,
        "FirewallManagerStatement": ...,
        "OverrideAction": ...,
        "VisibilityConfig": ...,
    }

Definition

class FirewallManagerRuleGroupTypeDef(TypedDict):
    Name: str,
    Priority: int,
    FirewallManagerStatement: FirewallManagerStatementTypeDef,  # (1)
    OverrideAction: OverrideActionTypeDef,  # (2)
    VisibilityConfig: VisibilityConfigTypeDef,  # (3)

1. See FirewallManagerStatementTypeDef
2. See OverrideActionTypeDef
3. See VisibilityConfigTypeDef

WebACLTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import WebACLTypeDef

def get_value() -> WebACLTypeDef:
    return {
        "Name": ...,
        "Id": ...,
        "ARN": ...,
        "DefaultAction": ...,
        "VisibilityConfig": ...,
    }

Definition

class WebACLTypeDef(TypedDict):
    Name: str,
    Id: str,
    ARN: str,
    DefaultAction: DefaultActionTypeDef,  # (1)
    VisibilityConfig: VisibilityConfigTypeDef,  # (3)
    Description: NotRequired[str],
    Rules: NotRequired[List[RuleTypeDef]],  # (2)
    Capacity: NotRequired[int],
    PreProcessFirewallManagerRuleGroups: NotRequired[List[FirewallManagerRuleGroupTypeDef]],  # (4)
    PostProcessFirewallManagerRuleGroups: NotRequired[List[FirewallManagerRuleGroupTypeDef]],  # (4)
    ManagedByFirewallManager: NotRequired[bool],
    LabelNamespace: NotRequired[str],
    CustomResponseBodies: NotRequired[Dict[str, CustomResponseBodyTypeDef]],  # (6)
    CaptchaConfig: NotRequired[CaptchaConfigTypeDef],  # (7)
    ChallengeConfig: NotRequired[ChallengeConfigTypeDef],  # (8)
    TokenDomains: NotRequired[List[str]],

1. See DefaultActionTypeDef
2. See RuleTypeDef
3. See VisibilityConfigTypeDef
4. See FirewallManagerRuleGroupTypeDef
5. See FirewallManagerRuleGroupTypeDef
6. See CustomResponseBodyTypeDef
7. See CaptchaConfigTypeDef
8. See ChallengeConfigTypeDef

GetWebACLForResourceResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetWebACLForResourceResponseTypeDef

def get_value() -> GetWebACLForResourceResponseTypeDef:
    return {
        "WebACL": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetWebACLForResourceResponseTypeDef(TypedDict):
    WebACL: WebACLTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See WebACLTypeDef
2. See ResponseMetadataTypeDef

GetWebACLResponseTypeDef

Usage Example

from mypy_boto3_wafv2.type_defs import GetWebACLResponseTypeDef

def get_value() -> GetWebACLResponseTypeDef:
    return {
        "WebACL": ...,
        "LockToken": ...,
        "ApplicationIntegrationURL": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetWebACLResponseTypeDef(TypedDict):
    WebACL: WebACLTypeDef,  # (1)
    LockToken: str,
    ApplicationIntegrationURL: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See WebACLTypeDef
2. See ResponseMetadataTypeDef