Skip to content

Typed dictionaries#

Index > WAFV2 > Typed dictionaries

Auto-generated documentation for WAFV2 type annotations stubs module mypy-boto3-wafv2.

APIKeySummaryTypeDef#

# APIKeySummaryTypeDef usage example

from mypy_boto3_wafv2.type_defs import APIKeySummaryTypeDef

def get_value() -> APIKeySummaryTypeDef:
    return {
        "TokenDomains": ...,
    }
# APIKeySummaryTypeDef definition

class APIKeySummaryTypeDef(TypedDict):
    TokenDomains: NotRequired[List[str]],
    APIKey: NotRequired[str],
    CreationTimestamp: NotRequired[datetime],
    Version: NotRequired[int],

AWSManagedRulesBotControlRuleSetTypeDef#

# AWSManagedRulesBotControlRuleSetTypeDef usage example

from mypy_boto3_wafv2.type_defs import AWSManagedRulesBotControlRuleSetTypeDef

def get_value() -> AWSManagedRulesBotControlRuleSetTypeDef:
    return {
        "InspectionLevel": ...,
    }
# AWSManagedRulesBotControlRuleSetTypeDef definition

class AWSManagedRulesBotControlRuleSetTypeDef(TypedDict):
    InspectionLevel: InspectionLevelType,  # (1)
  1. See InspectionLevelType

ActionConditionTypeDef#

# ActionConditionTypeDef usage example

from mypy_boto3_wafv2.type_defs import ActionConditionTypeDef

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

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

AndStatementTypeDef#

# AndStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import AndStatementTypeDef

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

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

AssociateWebACLRequestRequestTypeDef#

# AssociateWebACLRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import AssociateWebACLRequestRequestTypeDef

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

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

RequestBodyAssociatedResourceTypeConfigTypeDef#

# RequestBodyAssociatedResourceTypeConfigTypeDef usage example

from mypy_boto3_wafv2.type_defs import RequestBodyAssociatedResourceTypeConfigTypeDef

def get_value() -> RequestBodyAssociatedResourceTypeConfigTypeDef:
    return {
        "DefaultSizeInspectionLimit": ...,
    }
# RequestBodyAssociatedResourceTypeConfigTypeDef definition

class RequestBodyAssociatedResourceTypeConfigTypeDef(TypedDict):
    DefaultSizeInspectionLimit: SizeInspectionLimitType,  # (1)
  1. See SizeInspectionLimitType

BodyTypeDef#

# BodyTypeDef usage example

from mypy_boto3_wafv2.type_defs import BodyTypeDef

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

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

TextTransformationTypeDef#

# TextTransformationTypeDef usage example

from mypy_boto3_wafv2.type_defs import TextTransformationTypeDef

def get_value() -> TextTransformationTypeDef:
    return {
        "Priority": ...,
        "Type": ...,
    }
# TextTransformationTypeDef definition

class TextTransformationTypeDef(TypedDict):
    Priority: int,
    Type: TextTransformationTypeType,  # (1)
  1. See TextTransformationTypeType

ImmunityTimePropertyTypeDef#

# ImmunityTimePropertyTypeDef usage example

from mypy_boto3_wafv2.type_defs import ImmunityTimePropertyTypeDef

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

class ImmunityTimePropertyTypeDef(TypedDict):
    ImmunityTime: int,

CaptchaResponseTypeDef#

# CaptchaResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import CaptchaResponseTypeDef

def get_value() -> CaptchaResponseTypeDef:
    return {
        "ResponseCode": ...,
    }
# CaptchaResponseTypeDef definition

class CaptchaResponseTypeDef(TypedDict):
    ResponseCode: NotRequired[int],
    SolveTimestamp: NotRequired[int],
    FailureReason: NotRequired[FailureReasonType],  # (1)
  1. See FailureReasonType

ChallengeResponseTypeDef#

# ChallengeResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ChallengeResponseTypeDef

def get_value() -> ChallengeResponseTypeDef:
    return {
        "ResponseCode": ...,
    }
# ChallengeResponseTypeDef definition

class ChallengeResponseTypeDef(TypedDict):
    ResponseCode: NotRequired[int],
    SolveTimestamp: NotRequired[int],
    FailureReason: NotRequired[FailureReasonType],  # (1)
  1. See FailureReasonType

CheckCapacityResponseTypeDef#

# CheckCapacityResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import CheckCapacityResponseTypeDef

def get_value() -> CheckCapacityResponseTypeDef:
    return {
        "Capacity": ...,
        "ResponseMetadata": ...,
    }
# CheckCapacityResponseTypeDef definition

class CheckCapacityResponseTypeDef(TypedDict):
    Capacity: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

LabelNameConditionTypeDef#

# LabelNameConditionTypeDef usage example

from mypy_boto3_wafv2.type_defs import LabelNameConditionTypeDef

def get_value() -> LabelNameConditionTypeDef:
    return {
        "LabelName": ...,
    }
# LabelNameConditionTypeDef definition

class LabelNameConditionTypeDef(TypedDict):
    LabelName: str,

CookieMatchPatternTypeDef#

# CookieMatchPatternTypeDef usage example

from mypy_boto3_wafv2.type_defs import CookieMatchPatternTypeDef

def get_value() -> CookieMatchPatternTypeDef:
    return {
        "All": ...,
    }
# CookieMatchPatternTypeDef definition

class CookieMatchPatternTypeDef(TypedDict):
    All: NotRequired[Mapping[str, Any]],
    IncludedCookies: NotRequired[Sequence[str]],
    ExcludedCookies: NotRequired[Sequence[str]],

CreateAPIKeyRequestRequestTypeDef#

# CreateAPIKeyRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import CreateAPIKeyRequestRequestTypeDef

def get_value() -> CreateAPIKeyRequestRequestTypeDef:
    return {
        "Scope": ...,
        "TokenDomains": ...,
    }
# CreateAPIKeyRequestRequestTypeDef definition

class CreateAPIKeyRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
    TokenDomains: Sequence[str],
  1. See ScopeType

CreateAPIKeyResponseTypeDef#

# CreateAPIKeyResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import CreateAPIKeyResponseTypeDef

def get_value() -> CreateAPIKeyResponseTypeDef:
    return {
        "APIKey": ...,
        "ResponseMetadata": ...,
    }
# CreateAPIKeyResponseTypeDef definition

class CreateAPIKeyResponseTypeDef(TypedDict):
    APIKey: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TagTypeDef#

# TagTypeDef usage example

from mypy_boto3_wafv2.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
# TagTypeDef definition

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

IPSetSummaryTypeDef#

# IPSetSummaryTypeDef usage example

from mypy_boto3_wafv2.type_defs import IPSetSummaryTypeDef

def get_value() -> IPSetSummaryTypeDef:
    return {
        "Name": ...,
    }
# IPSetSummaryTypeDef definition

class IPSetSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    Id: NotRequired[str],
    Description: NotRequired[str],
    LockToken: NotRequired[str],
    ARN: NotRequired[str],

RegexTypeDef#

# RegexTypeDef usage example

from mypy_boto3_wafv2.type_defs import RegexTypeDef

def get_value() -> RegexTypeDef:
    return {
        "RegexString": ...,
    }
# RegexTypeDef definition

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

RegexPatternSetSummaryTypeDef#

# RegexPatternSetSummaryTypeDef usage example

from mypy_boto3_wafv2.type_defs import RegexPatternSetSummaryTypeDef

def get_value() -> RegexPatternSetSummaryTypeDef:
    return {
        "Name": ...,
    }
# RegexPatternSetSummaryTypeDef definition

class RegexPatternSetSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    Id: NotRequired[str],
    Description: NotRequired[str],
    LockToken: NotRequired[str],
    ARN: NotRequired[str],

CustomResponseBodyTypeDef#

# CustomResponseBodyTypeDef usage example

from mypy_boto3_wafv2.type_defs import CustomResponseBodyTypeDef

def get_value() -> CustomResponseBodyTypeDef:
    return {
        "ContentType": ...,
        "Content": ...,
    }
# CustomResponseBodyTypeDef definition

class CustomResponseBodyTypeDef(TypedDict):
    ContentType: ResponseContentTypeType,  # (1)
    Content: str,
  1. See ResponseContentTypeType

VisibilityConfigTypeDef#

# VisibilityConfigTypeDef usage example

from mypy_boto3_wafv2.type_defs import VisibilityConfigTypeDef

def get_value() -> VisibilityConfigTypeDef:
    return {
        "SampledRequestsEnabled": ...,
        "CloudWatchMetricsEnabled": ...,
        "MetricName": ...,
    }
# VisibilityConfigTypeDef definition

class VisibilityConfigTypeDef(TypedDict):
    SampledRequestsEnabled: bool,
    CloudWatchMetricsEnabled: bool,
    MetricName: str,

RuleGroupSummaryTypeDef#

# RuleGroupSummaryTypeDef usage example

from mypy_boto3_wafv2.type_defs import RuleGroupSummaryTypeDef

def get_value() -> RuleGroupSummaryTypeDef:
    return {
        "Name": ...,
    }
# RuleGroupSummaryTypeDef definition

class RuleGroupSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    Id: NotRequired[str],
    Description: NotRequired[str],
    LockToken: NotRequired[str],
    ARN: NotRequired[str],

WebACLSummaryTypeDef#

# WebACLSummaryTypeDef usage example

from mypy_boto3_wafv2.type_defs import WebACLSummaryTypeDef

def get_value() -> WebACLSummaryTypeDef:
    return {
        "Name": ...,
    }
# WebACLSummaryTypeDef definition

class WebACLSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    Id: NotRequired[str],
    Description: NotRequired[str],
    LockToken: NotRequired[str],
    ARN: NotRequired[str],

CustomHTTPHeaderTypeDef#

# CustomHTTPHeaderTypeDef usage example

from mypy_boto3_wafv2.type_defs import CustomHTTPHeaderTypeDef

def get_value() -> CustomHTTPHeaderTypeDef:
    return {
        "Name": ...,
        "Value": ...,
    }
# CustomHTTPHeaderTypeDef definition

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

DeleteFirewallManagerRuleGroupsRequestRequestTypeDef#

# DeleteFirewallManagerRuleGroupsRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import DeleteFirewallManagerRuleGroupsRequestRequestTypeDef

def get_value() -> DeleteFirewallManagerRuleGroupsRequestRequestTypeDef:
    return {
        "WebACLArn": ...,
        "WebACLLockToken": ...,
    }
# DeleteFirewallManagerRuleGroupsRequestRequestTypeDef definition

class DeleteFirewallManagerRuleGroupsRequestRequestTypeDef(TypedDict):
    WebACLArn: str,
    WebACLLockToken: str,

DeleteFirewallManagerRuleGroupsResponseTypeDef#

# DeleteFirewallManagerRuleGroupsResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import DeleteFirewallManagerRuleGroupsResponseTypeDef

def get_value() -> DeleteFirewallManagerRuleGroupsResponseTypeDef:
    return {
        "NextWebACLLockToken": ...,
        "ResponseMetadata": ...,
    }
# DeleteFirewallManagerRuleGroupsResponseTypeDef definition

class DeleteFirewallManagerRuleGroupsResponseTypeDef(TypedDict):
    NextWebACLLockToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteIPSetRequestRequestTypeDef#

# DeleteIPSetRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import DeleteIPSetRequestRequestTypeDef

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

class DeleteIPSetRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
  1. See ScopeType

DeleteLoggingConfigurationRequestRequestTypeDef#

# DeleteLoggingConfigurationRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import DeleteLoggingConfigurationRequestRequestTypeDef

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

class DeleteLoggingConfigurationRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DeletePermissionPolicyRequestRequestTypeDef#

# DeletePermissionPolicyRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import DeletePermissionPolicyRequestRequestTypeDef

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

class DeletePermissionPolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DeleteRegexPatternSetRequestRequestTypeDef#

# DeleteRegexPatternSetRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import DeleteRegexPatternSetRequestRequestTypeDef

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

class DeleteRegexPatternSetRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
  1. See ScopeType

DeleteRuleGroupRequestRequestTypeDef#

# DeleteRuleGroupRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import DeleteRuleGroupRequestRequestTypeDef

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

class DeleteRuleGroupRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
  1. See ScopeType

DeleteWebACLRequestRequestTypeDef#

# DeleteWebACLRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import DeleteWebACLRequestRequestTypeDef

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

class DeleteWebACLRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
  1. See ScopeType

DescribeManagedRuleGroupRequestRequestTypeDef#

# DescribeManagedRuleGroupRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import DescribeManagedRuleGroupRequestRequestTypeDef

def get_value() -> DescribeManagedRuleGroupRequestRequestTypeDef:
    return {
        "VendorName": ...,
        "Name": ...,
        "Scope": ...,
    }
# DescribeManagedRuleGroupRequestRequestTypeDef definition

class DescribeManagedRuleGroupRequestRequestTypeDef(TypedDict):
    VendorName: str,
    Name: str,
    Scope: ScopeType,  # (1)
    VersionName: NotRequired[str],
  1. See ScopeType

LabelSummaryTypeDef#

# LabelSummaryTypeDef usage example

from mypy_boto3_wafv2.type_defs import LabelSummaryTypeDef

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

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

DisassociateWebACLRequestRequestTypeDef#

# DisassociateWebACLRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import DisassociateWebACLRequestRequestTypeDef

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

class DisassociateWebACLRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ExcludedRuleTypeDef#

# ExcludedRuleTypeDef usage example

from mypy_boto3_wafv2.type_defs import ExcludedRuleTypeDef

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

class ExcludedRuleTypeDef(TypedDict):
    Name: str,

SingleHeaderTypeDef#

# SingleHeaderTypeDef usage example

from mypy_boto3_wafv2.type_defs import SingleHeaderTypeDef

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

class SingleHeaderTypeDef(TypedDict):
    Name: str,

SingleQueryArgumentTypeDef#

# SingleQueryArgumentTypeDef usage example

from mypy_boto3_wafv2.type_defs import SingleQueryArgumentTypeDef

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

class SingleQueryArgumentTypeDef(TypedDict):
    Name: str,

ForwardedIPConfigTypeDef#

# ForwardedIPConfigTypeDef usage example

from mypy_boto3_wafv2.type_defs import ForwardedIPConfigTypeDef

def get_value() -> ForwardedIPConfigTypeDef:
    return {
        "HeaderName": ...,
        "FallbackBehavior": ...,
    }
# ForwardedIPConfigTypeDef definition

class ForwardedIPConfigTypeDef(TypedDict):
    HeaderName: str,
    FallbackBehavior: FallbackBehaviorType,  # (1)
  1. See FallbackBehaviorType

GenerateMobileSdkReleaseUrlRequestRequestTypeDef#

# GenerateMobileSdkReleaseUrlRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GenerateMobileSdkReleaseUrlRequestRequestTypeDef

def get_value() -> GenerateMobileSdkReleaseUrlRequestRequestTypeDef:
    return {
        "Platform": ...,
        "ReleaseVersion": ...,
    }
# GenerateMobileSdkReleaseUrlRequestRequestTypeDef definition

class GenerateMobileSdkReleaseUrlRequestRequestTypeDef(TypedDict):
    Platform: PlatformType,  # (1)
    ReleaseVersion: str,
  1. See PlatformType

GenerateMobileSdkReleaseUrlResponseTypeDef#

# GenerateMobileSdkReleaseUrlResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GenerateMobileSdkReleaseUrlResponseTypeDef

def get_value() -> GenerateMobileSdkReleaseUrlResponseTypeDef:
    return {
        "Url": ...,
        "ResponseMetadata": ...,
    }
# GenerateMobileSdkReleaseUrlResponseTypeDef definition

class GenerateMobileSdkReleaseUrlResponseTypeDef(TypedDict):
    Url: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetDecryptedAPIKeyRequestRequestTypeDef#

# GetDecryptedAPIKeyRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetDecryptedAPIKeyRequestRequestTypeDef

def get_value() -> GetDecryptedAPIKeyRequestRequestTypeDef:
    return {
        "Scope": ...,
        "APIKey": ...,
    }
# GetDecryptedAPIKeyRequestRequestTypeDef definition

class GetDecryptedAPIKeyRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
    APIKey: str,
  1. See ScopeType

GetDecryptedAPIKeyResponseTypeDef#

# GetDecryptedAPIKeyResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetDecryptedAPIKeyResponseTypeDef

def get_value() -> GetDecryptedAPIKeyResponseTypeDef:
    return {
        "TokenDomains": ...,
        "CreationTimestamp": ...,
        "ResponseMetadata": ...,
    }
# GetDecryptedAPIKeyResponseTypeDef definition

class GetDecryptedAPIKeyResponseTypeDef(TypedDict):
    TokenDomains: List[str],
    CreationTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetIPSetRequestRequestTypeDef#

# GetIPSetRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetIPSetRequestRequestTypeDef

def get_value() -> GetIPSetRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
    }
# GetIPSetRequestRequestTypeDef definition

class GetIPSetRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
  1. See ScopeType

IPSetTypeDef#

# IPSetTypeDef usage example

from mypy_boto3_wafv2.type_defs import IPSetTypeDef

def get_value() -> IPSetTypeDef:
    return {
        "Name": ...,
        "Id": ...,
        "ARN": ...,
        "IPAddressVersion": ...,
        "Addresses": ...,
    }
# IPSetTypeDef definition

class IPSetTypeDef(TypedDict):
    Name: str,
    Id: str,
    ARN: str,
    IPAddressVersion: IPAddressVersionType,  # (1)
    Addresses: List[str],
    Description: NotRequired[str],
  1. See IPAddressVersionType

GetLoggingConfigurationRequestRequestTypeDef#

# GetLoggingConfigurationRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetLoggingConfigurationRequestRequestTypeDef

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

class GetLoggingConfigurationRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

GetManagedRuleSetRequestRequestTypeDef#

# GetManagedRuleSetRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetManagedRuleSetRequestRequestTypeDef

def get_value() -> GetManagedRuleSetRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
    }
# GetManagedRuleSetRequestRequestTypeDef definition

class GetManagedRuleSetRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
  1. See ScopeType

GetMobileSdkReleaseRequestRequestTypeDef#

# GetMobileSdkReleaseRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetMobileSdkReleaseRequestRequestTypeDef

def get_value() -> GetMobileSdkReleaseRequestRequestTypeDef:
    return {
        "Platform": ...,
        "ReleaseVersion": ...,
    }
# GetMobileSdkReleaseRequestRequestTypeDef definition

class GetMobileSdkReleaseRequestRequestTypeDef(TypedDict):
    Platform: PlatformType,  # (1)
    ReleaseVersion: str,
  1. See PlatformType

GetPermissionPolicyRequestRequestTypeDef#

# GetPermissionPolicyRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetPermissionPolicyRequestRequestTypeDef

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

class GetPermissionPolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

GetPermissionPolicyResponseTypeDef#

# GetPermissionPolicyResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetPermissionPolicyResponseTypeDef

def get_value() -> GetPermissionPolicyResponseTypeDef:
    return {
        "Policy": ...,
        "ResponseMetadata": ...,
    }
# GetPermissionPolicyResponseTypeDef definition

class GetPermissionPolicyResponseTypeDef(TypedDict):
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetRateBasedStatementManagedKeysRequestRequestTypeDef#

# GetRateBasedStatementManagedKeysRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetRateBasedStatementManagedKeysRequestRequestTypeDef

def get_value() -> GetRateBasedStatementManagedKeysRequestRequestTypeDef:
    return {
        "Scope": ...,
        "WebACLName": ...,
        "WebACLId": ...,
        "RuleName": ...,
    }
# GetRateBasedStatementManagedKeysRequestRequestTypeDef definition

class GetRateBasedStatementManagedKeysRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
    WebACLName: str,
    WebACLId: str,
    RuleName: str,
    RuleGroupRuleName: NotRequired[str],
  1. See ScopeType

RateBasedStatementManagedKeysIPSetTypeDef#

# RateBasedStatementManagedKeysIPSetTypeDef usage example

from mypy_boto3_wafv2.type_defs import RateBasedStatementManagedKeysIPSetTypeDef

def get_value() -> RateBasedStatementManagedKeysIPSetTypeDef:
    return {
        "IPAddressVersion": ...,
    }
# RateBasedStatementManagedKeysIPSetTypeDef definition

class RateBasedStatementManagedKeysIPSetTypeDef(TypedDict):
    IPAddressVersion: NotRequired[IPAddressVersionType],  # (1)
    Addresses: NotRequired[List[str]],
  1. See IPAddressVersionType

GetRegexPatternSetRequestRequestTypeDef#

# GetRegexPatternSetRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetRegexPatternSetRequestRequestTypeDef

def get_value() -> GetRegexPatternSetRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
    }
# GetRegexPatternSetRequestRequestTypeDef definition

class GetRegexPatternSetRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
  1. See ScopeType

GetRuleGroupRequestRequestTypeDef#

# GetRuleGroupRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetRuleGroupRequestRequestTypeDef

def get_value() -> GetRuleGroupRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# GetRuleGroupRequestRequestTypeDef definition

class GetRuleGroupRequestRequestTypeDef(TypedDict):
    Name: NotRequired[str],
    Scope: NotRequired[ScopeType],  # (1)
    Id: NotRequired[str],
    ARN: NotRequired[str],
  1. See ScopeType

TimeWindowTypeDef#

# TimeWindowTypeDef usage example

from mypy_boto3_wafv2.type_defs import TimeWindowTypeDef

def get_value() -> TimeWindowTypeDef:
    return {
        "StartTime": ...,
        "EndTime": ...,
    }
# TimeWindowTypeDef definition

class TimeWindowTypeDef(TypedDict):
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],

GetWebACLForResourceRequestRequestTypeDef#

# GetWebACLForResourceRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetWebACLForResourceRequestRequestTypeDef

def get_value() -> GetWebACLForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
# GetWebACLForResourceRequestRequestTypeDef definition

class GetWebACLForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

GetWebACLRequestRequestTypeDef#

# GetWebACLRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetWebACLRequestRequestTypeDef

def get_value() -> GetWebACLRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
    }
# GetWebACLRequestRequestTypeDef definition

class GetWebACLRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
  1. See ScopeType

HTTPHeaderTypeDef#

# HTTPHeaderTypeDef usage example

from mypy_boto3_wafv2.type_defs import HTTPHeaderTypeDef

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

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

HeaderMatchPatternTypeDef#

# HeaderMatchPatternTypeDef usage example

from mypy_boto3_wafv2.type_defs import HeaderMatchPatternTypeDef

def get_value() -> HeaderMatchPatternTypeDef:
    return {
        "All": ...,
    }
# HeaderMatchPatternTypeDef definition

class HeaderMatchPatternTypeDef(TypedDict):
    All: NotRequired[Mapping[str, Any]],
    IncludedHeaders: NotRequired[Sequence[str]],
    ExcludedHeaders: NotRequired[Sequence[str]],

IPSetForwardedIPConfigTypeDef#

# IPSetForwardedIPConfigTypeDef usage example

from mypy_boto3_wafv2.type_defs import IPSetForwardedIPConfigTypeDef

def get_value() -> IPSetForwardedIPConfigTypeDef:
    return {
        "HeaderName": ...,
        "FallbackBehavior": ...,
        "Position": ...,
    }
# IPSetForwardedIPConfigTypeDef definition

class IPSetForwardedIPConfigTypeDef(TypedDict):
    HeaderName: str,
    FallbackBehavior: FallbackBehaviorType,  # (1)
    Position: ForwardedIPPositionType,  # (2)
  1. See FallbackBehaviorType
  2. See ForwardedIPPositionType

JsonMatchPatternTypeDef#

# JsonMatchPatternTypeDef usage example

from mypy_boto3_wafv2.type_defs import JsonMatchPatternTypeDef

def get_value() -> JsonMatchPatternTypeDef:
    return {
        "All": ...,
    }
# JsonMatchPatternTypeDef definition

class JsonMatchPatternTypeDef(TypedDict):
    All: NotRequired[Mapping[str, Any]],
    IncludedPaths: NotRequired[Sequence[str]],

LabelMatchStatementTypeDef#

# LabelMatchStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import LabelMatchStatementTypeDef

def get_value() -> LabelMatchStatementTypeDef:
    return {
        "Scope": ...,
        "Key": ...,
    }
# LabelMatchStatementTypeDef definition

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

LabelTypeDef#

# LabelTypeDef usage example

from mypy_boto3_wafv2.type_defs import LabelTypeDef

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

class LabelTypeDef(TypedDict):
    Name: str,

ListAPIKeysRequestRequestTypeDef#

# ListAPIKeysRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListAPIKeysRequestRequestTypeDef

def get_value() -> ListAPIKeysRequestRequestTypeDef:
    return {
        "Scope": ...,
    }
# ListAPIKeysRequestRequestTypeDef definition

class ListAPIKeysRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
    NextMarker: NotRequired[str],
    Limit: NotRequired[int],
  1. See ScopeType

ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef#

# ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef

def get_value() -> ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef:
    return {
        "VendorName": ...,
        "Name": ...,
        "Scope": ...,
    }
# ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef definition

class ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef(TypedDict):
    VendorName: str,
    Name: str,
    Scope: ScopeType,  # (1)
    NextMarker: NotRequired[str],
    Limit: NotRequired[int],
  1. See ScopeType

ManagedRuleGroupVersionTypeDef#

# ManagedRuleGroupVersionTypeDef usage example

from mypy_boto3_wafv2.type_defs import ManagedRuleGroupVersionTypeDef

def get_value() -> ManagedRuleGroupVersionTypeDef:
    return {
        "Name": ...,
    }
# ManagedRuleGroupVersionTypeDef definition

class ManagedRuleGroupVersionTypeDef(TypedDict):
    Name: NotRequired[str],
    LastUpdateTimestamp: NotRequired[datetime],

ListAvailableManagedRuleGroupsRequestRequestTypeDef#

# ListAvailableManagedRuleGroupsRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListAvailableManagedRuleGroupsRequestRequestTypeDef

def get_value() -> ListAvailableManagedRuleGroupsRequestRequestTypeDef:
    return {
        "Scope": ...,
    }
# ListAvailableManagedRuleGroupsRequestRequestTypeDef definition

class ListAvailableManagedRuleGroupsRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
    NextMarker: NotRequired[str],
    Limit: NotRequired[int],
  1. See ScopeType

ManagedRuleGroupSummaryTypeDef#

# ManagedRuleGroupSummaryTypeDef usage example

from mypy_boto3_wafv2.type_defs import ManagedRuleGroupSummaryTypeDef

def get_value() -> ManagedRuleGroupSummaryTypeDef:
    return {
        "VendorName": ...,
    }
# ManagedRuleGroupSummaryTypeDef definition

class ManagedRuleGroupSummaryTypeDef(TypedDict):
    VendorName: NotRequired[str],
    Name: NotRequired[str],
    VersioningSupported: NotRequired[bool],
    Description: NotRequired[str],

ListIPSetsRequestRequestTypeDef#

# ListIPSetsRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListIPSetsRequestRequestTypeDef

def get_value() -> ListIPSetsRequestRequestTypeDef:
    return {
        "Scope": ...,
    }
# ListIPSetsRequestRequestTypeDef definition

class ListIPSetsRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
    NextMarker: NotRequired[str],
    Limit: NotRequired[int],
  1. See ScopeType

ListLoggingConfigurationsRequestRequestTypeDef#

# ListLoggingConfigurationsRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListLoggingConfigurationsRequestRequestTypeDef

def get_value() -> ListLoggingConfigurationsRequestRequestTypeDef:
    return {
        "Scope": ...,
    }
# ListLoggingConfigurationsRequestRequestTypeDef definition

class ListLoggingConfigurationsRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
    NextMarker: NotRequired[str],
    Limit: NotRequired[int],
  1. See ScopeType

ListManagedRuleSetsRequestRequestTypeDef#

# ListManagedRuleSetsRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListManagedRuleSetsRequestRequestTypeDef

def get_value() -> ListManagedRuleSetsRequestRequestTypeDef:
    return {
        "Scope": ...,
    }
# ListManagedRuleSetsRequestRequestTypeDef definition

class ListManagedRuleSetsRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
    NextMarker: NotRequired[str],
    Limit: NotRequired[int],
  1. See ScopeType

ManagedRuleSetSummaryTypeDef#

# ManagedRuleSetSummaryTypeDef usage example

from mypy_boto3_wafv2.type_defs import ManagedRuleSetSummaryTypeDef

def get_value() -> ManagedRuleSetSummaryTypeDef:
    return {
        "Name": ...,
    }
# ManagedRuleSetSummaryTypeDef definition

class ManagedRuleSetSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    Id: NotRequired[str],
    Description: NotRequired[str],
    LockToken: NotRequired[str],
    ARN: NotRequired[str],
    LabelNamespace: NotRequired[str],

ListMobileSdkReleasesRequestRequestTypeDef#

# ListMobileSdkReleasesRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListMobileSdkReleasesRequestRequestTypeDef

def get_value() -> ListMobileSdkReleasesRequestRequestTypeDef:
    return {
        "Platform": ...,
    }
# ListMobileSdkReleasesRequestRequestTypeDef definition

class ListMobileSdkReleasesRequestRequestTypeDef(TypedDict):
    Platform: PlatformType,  # (1)
    NextMarker: NotRequired[str],
    Limit: NotRequired[int],
  1. See PlatformType

ReleaseSummaryTypeDef#

# ReleaseSummaryTypeDef usage example

from mypy_boto3_wafv2.type_defs import ReleaseSummaryTypeDef

def get_value() -> ReleaseSummaryTypeDef:
    return {
        "ReleaseVersion": ...,
    }
# ReleaseSummaryTypeDef definition

class ReleaseSummaryTypeDef(TypedDict):
    ReleaseVersion: NotRequired[str],
    Timestamp: NotRequired[datetime],

ListRegexPatternSetsRequestRequestTypeDef#

# ListRegexPatternSetsRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListRegexPatternSetsRequestRequestTypeDef

def get_value() -> ListRegexPatternSetsRequestRequestTypeDef:
    return {
        "Scope": ...,
    }
# ListRegexPatternSetsRequestRequestTypeDef definition

class ListRegexPatternSetsRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
    NextMarker: NotRequired[str],
    Limit: NotRequired[int],
  1. See ScopeType

ListResourcesForWebACLRequestRequestTypeDef#

# ListResourcesForWebACLRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListResourcesForWebACLRequestRequestTypeDef

def get_value() -> ListResourcesForWebACLRequestRequestTypeDef:
    return {
        "WebACLArn": ...,
    }
# ListResourcesForWebACLRequestRequestTypeDef definition

class ListResourcesForWebACLRequestRequestTypeDef(TypedDict):
    WebACLArn: str,
    ResourceType: NotRequired[ResourceTypeType],  # (1)
  1. See ResourceTypeType

ListResourcesForWebACLResponseTypeDef#

# ListResourcesForWebACLResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListResourcesForWebACLResponseTypeDef

def get_value() -> ListResourcesForWebACLResponseTypeDef:
    return {
        "ResourceArns": ...,
        "ResponseMetadata": ...,
    }
# ListResourcesForWebACLResponseTypeDef definition

class ListResourcesForWebACLResponseTypeDef(TypedDict):
    ResourceArns: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListRuleGroupsRequestRequestTypeDef#

# ListRuleGroupsRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListRuleGroupsRequestRequestTypeDef

def get_value() -> ListRuleGroupsRequestRequestTypeDef:
    return {
        "Scope": ...,
    }
# ListRuleGroupsRequestRequestTypeDef definition

class ListRuleGroupsRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
    NextMarker: NotRequired[str],
    Limit: NotRequired[int],
  1. See ScopeType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    NextMarker: NotRequired[str],
    Limit: NotRequired[int],

ListWebACLsRequestRequestTypeDef#

# ListWebACLsRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListWebACLsRequestRequestTypeDef

def get_value() -> ListWebACLsRequestRequestTypeDef:
    return {
        "Scope": ...,
    }
# ListWebACLsRequestRequestTypeDef definition

class ListWebACLsRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
    NextMarker: NotRequired[str],
    Limit: NotRequired[int],
  1. See ScopeType

PasswordFieldTypeDef#

# PasswordFieldTypeDef usage example

from mypy_boto3_wafv2.type_defs import PasswordFieldTypeDef

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

class PasswordFieldTypeDef(TypedDict):
    Identifier: str,

UsernameFieldTypeDef#

# UsernameFieldTypeDef usage example

from mypy_boto3_wafv2.type_defs import UsernameFieldTypeDef

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

class UsernameFieldTypeDef(TypedDict):
    Identifier: str,

ManagedRuleSetVersionTypeDef#

# ManagedRuleSetVersionTypeDef usage example

from mypy_boto3_wafv2.type_defs import ManagedRuleSetVersionTypeDef

def get_value() -> ManagedRuleSetVersionTypeDef:
    return {
        "AssociatedRuleGroupArn": ...,
    }
# ManagedRuleSetVersionTypeDef definition

class ManagedRuleSetVersionTypeDef(TypedDict):
    AssociatedRuleGroupArn: NotRequired[str],
    Capacity: NotRequired[int],
    ForecastedLifetime: NotRequired[int],
    PublishTimestamp: NotRequired[datetime],
    LastUpdateTimestamp: NotRequired[datetime],
    ExpiryTimestamp: NotRequired[datetime],

NotStatementTypeDef#

# NotStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import NotStatementTypeDef

def get_value() -> NotStatementTypeDef:
    return {
        "Statement": ...,
    }
# NotStatementTypeDef definition

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

OrStatementTypeDef#

# OrStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import OrStatementTypeDef

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

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

VersionToPublishTypeDef#

# VersionToPublishTypeDef usage example

from mypy_boto3_wafv2.type_defs import VersionToPublishTypeDef

def get_value() -> VersionToPublishTypeDef:
    return {
        "AssociatedRuleGroupArn": ...,
    }
# VersionToPublishTypeDef definition

class VersionToPublishTypeDef(TypedDict):
    AssociatedRuleGroupArn: NotRequired[str],
    ForecastedLifetime: NotRequired[int],

PutManagedRuleSetVersionsResponseTypeDef#

# PutManagedRuleSetVersionsResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import PutManagedRuleSetVersionsResponseTypeDef

def get_value() -> PutManagedRuleSetVersionsResponseTypeDef:
    return {
        "NextLockToken": ...,
        "ResponseMetadata": ...,
    }
# PutManagedRuleSetVersionsResponseTypeDef definition

class PutManagedRuleSetVersionsResponseTypeDef(TypedDict):
    NextLockToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutPermissionPolicyRequestRequestTypeDef#

# PutPermissionPolicyRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import PutPermissionPolicyRequestRequestTypeDef

def get_value() -> PutPermissionPolicyRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Policy": ...,
    }
# PutPermissionPolicyRequestRequestTypeDef definition

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

RateLimitLabelNamespaceTypeDef#

# RateLimitLabelNamespaceTypeDef usage example

from mypy_boto3_wafv2.type_defs import RateLimitLabelNamespaceTypeDef

def get_value() -> RateLimitLabelNamespaceTypeDef:
    return {
        "Namespace": ...,
    }
# RateLimitLabelNamespaceTypeDef definition

class RateLimitLabelNamespaceTypeDef(TypedDict):
    Namespace: str,

ResponseInspectionBodyContainsTypeDef#

# ResponseInspectionBodyContainsTypeDef usage example

from mypy_boto3_wafv2.type_defs import ResponseInspectionBodyContainsTypeDef

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

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

ResponseInspectionHeaderTypeDef#

# ResponseInspectionHeaderTypeDef usage example

from mypy_boto3_wafv2.type_defs import ResponseInspectionHeaderTypeDef

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

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

ResponseInspectionJsonTypeDef#

# ResponseInspectionJsonTypeDef usage example

from mypy_boto3_wafv2.type_defs import ResponseInspectionJsonTypeDef

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

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

ResponseInspectionStatusCodeTypeDef#

# ResponseInspectionStatusCodeTypeDef usage example

from mypy_boto3_wafv2.type_defs import ResponseInspectionStatusCodeTypeDef

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

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_wafv2.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "TagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateIPSetRequestRequestTypeDef#

# UpdateIPSetRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import UpdateIPSetRequestRequestTypeDef

def get_value() -> UpdateIPSetRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
        "Addresses": ...,
        "LockToken": ...,
    }
# UpdateIPSetRequestRequestTypeDef definition

class UpdateIPSetRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    Addresses: Sequence[str],
    LockToken: str,
    Description: NotRequired[str],
  1. See ScopeType

UpdateIPSetResponseTypeDef#

# UpdateIPSetResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import UpdateIPSetResponseTypeDef

def get_value() -> UpdateIPSetResponseTypeDef:
    return {
        "NextLockToken": ...,
        "ResponseMetadata": ...,
    }
# UpdateIPSetResponseTypeDef definition

class UpdateIPSetResponseTypeDef(TypedDict):
    NextLockToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef#

# UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef

def get_value() -> UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
        "LockToken": ...,
        "VersionToExpire": ...,
        "ExpiryTimestamp": ...,
    }
# UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef definition

class UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef(TypedDict):
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
    VersionToExpire: str,
    ExpiryTimestamp: Union[datetime, str],
  1. See ScopeType

UpdateManagedRuleSetVersionExpiryDateResponseTypeDef#

# UpdateManagedRuleSetVersionExpiryDateResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import UpdateManagedRuleSetVersionExpiryDateResponseTypeDef

def get_value() -> UpdateManagedRuleSetVersionExpiryDateResponseTypeDef:
    return {
        "ExpiringVersion": ...,
        "ExpiryTimestamp": ...,
        "NextLockToken": ...,
        "ResponseMetadata": ...,
    }
# UpdateManagedRuleSetVersionExpiryDateResponseTypeDef definition

class UpdateManagedRuleSetVersionExpiryDateResponseTypeDef(TypedDict):
    ExpiringVersion: str,
    ExpiryTimestamp: datetime,
    NextLockToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateRegexPatternSetResponseTypeDef#

# UpdateRegexPatternSetResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import UpdateRegexPatternSetResponseTypeDef

def get_value() -> UpdateRegexPatternSetResponseTypeDef:
    return {
        "NextLockToken": ...,
        "ResponseMetadata": ...,
    }
# UpdateRegexPatternSetResponseTypeDef definition

class UpdateRegexPatternSetResponseTypeDef(TypedDict):
    NextLockToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateRuleGroupResponseTypeDef#

# UpdateRuleGroupResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import UpdateRuleGroupResponseTypeDef

def get_value() -> UpdateRuleGroupResponseTypeDef:
    return {
        "NextLockToken": ...,
        "ResponseMetadata": ...,
    }
# UpdateRuleGroupResponseTypeDef definition

class UpdateRuleGroupResponseTypeDef(TypedDict):
    NextLockToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateWebACLResponseTypeDef#

# UpdateWebACLResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import UpdateWebACLResponseTypeDef

def get_value() -> UpdateWebACLResponseTypeDef:
    return {
        "NextLockToken": ...,
        "ResponseMetadata": ...,
    }
# UpdateWebACLResponseTypeDef definition

class UpdateWebACLResponseTypeDef(TypedDict):
    NextLockToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAPIKeysResponseTypeDef#

# ListAPIKeysResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListAPIKeysResponseTypeDef

def get_value() -> ListAPIKeysResponseTypeDef:
    return {
        "NextMarker": ...,
        "APIKeySummaries": ...,
        "ApplicationIntegrationURL": ...,
        "ResponseMetadata": ...,
    }
# ListAPIKeysResponseTypeDef definition

class ListAPIKeysResponseTypeDef(TypedDict):
    NextMarker: str,
    APIKeySummaries: List[APIKeySummaryTypeDef],  # (1)
    ApplicationIntegrationURL: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See APIKeySummaryTypeDef
  2. See ResponseMetadataTypeDef

AssociationConfigTypeDef#

# AssociationConfigTypeDef usage example

from mypy_boto3_wafv2.type_defs import AssociationConfigTypeDef

def get_value() -> AssociationConfigTypeDef:
    return {
        "RequestBody": ...,
    }
# AssociationConfigTypeDef definition

class AssociationConfigTypeDef(TypedDict):
    RequestBody: NotRequired[Mapping[AssociatedResourceTypeType, RequestBodyAssociatedResourceTypeConfigTypeDef]],  # (1)
  1. See AssociatedResourceTypeType RequestBodyAssociatedResourceTypeConfigTypeDef

RateLimitCookieTypeDef#

# RateLimitCookieTypeDef usage example

from mypy_boto3_wafv2.type_defs import RateLimitCookieTypeDef

def get_value() -> RateLimitCookieTypeDef:
    return {
        "Name": ...,
        "TextTransformations": ...,
    }
# RateLimitCookieTypeDef definition

class RateLimitCookieTypeDef(TypedDict):
    Name: str,
    TextTransformations: Sequence[TextTransformationTypeDef],  # (1)
  1. See TextTransformationTypeDef

RateLimitHeaderTypeDef#

# RateLimitHeaderTypeDef usage example

from mypy_boto3_wafv2.type_defs import RateLimitHeaderTypeDef

def get_value() -> RateLimitHeaderTypeDef:
    return {
        "Name": ...,
        "TextTransformations": ...,
    }
# RateLimitHeaderTypeDef definition

class RateLimitHeaderTypeDef(TypedDict):
    Name: str,
    TextTransformations: Sequence[TextTransformationTypeDef],  # (1)
  1. See TextTransformationTypeDef

RateLimitQueryArgumentTypeDef#

# RateLimitQueryArgumentTypeDef usage example

from mypy_boto3_wafv2.type_defs import RateLimitQueryArgumentTypeDef

def get_value() -> RateLimitQueryArgumentTypeDef:
    return {
        "Name": ...,
        "TextTransformations": ...,
    }
# RateLimitQueryArgumentTypeDef definition

class RateLimitQueryArgumentTypeDef(TypedDict):
    Name: str,
    TextTransformations: Sequence[TextTransformationTypeDef],  # (1)
  1. See TextTransformationTypeDef

RateLimitQueryStringTypeDef#

# RateLimitQueryStringTypeDef usage example

from mypy_boto3_wafv2.type_defs import RateLimitQueryStringTypeDef

def get_value() -> RateLimitQueryStringTypeDef:
    return {
        "TextTransformations": ...,
    }
# RateLimitQueryStringTypeDef definition

class RateLimitQueryStringTypeDef(TypedDict):
    TextTransformations: Sequence[TextTransformationTypeDef],  # (1)
  1. See TextTransformationTypeDef

CaptchaConfigTypeDef#

# CaptchaConfigTypeDef usage example

from mypy_boto3_wafv2.type_defs import CaptchaConfigTypeDef

def get_value() -> CaptchaConfigTypeDef:
    return {
        "ImmunityTimeProperty": ...,
    }
# CaptchaConfigTypeDef definition

class CaptchaConfigTypeDef(TypedDict):
    ImmunityTimeProperty: NotRequired[ImmunityTimePropertyTypeDef],  # (1)
  1. See ImmunityTimePropertyTypeDef

ChallengeConfigTypeDef#

# ChallengeConfigTypeDef usage example

from mypy_boto3_wafv2.type_defs import ChallengeConfigTypeDef

def get_value() -> ChallengeConfigTypeDef:
    return {
        "ImmunityTimeProperty": ...,
    }
# ChallengeConfigTypeDef definition

class ChallengeConfigTypeDef(TypedDict):
    ImmunityTimeProperty: NotRequired[ImmunityTimePropertyTypeDef],  # (1)
  1. See ImmunityTimePropertyTypeDef

ConditionTypeDef#

# ConditionTypeDef usage example

from mypy_boto3_wafv2.type_defs import ConditionTypeDef

def get_value() -> ConditionTypeDef:
    return {
        "ActionCondition": ...,
    }
# ConditionTypeDef definition

class ConditionTypeDef(TypedDict):
    ActionCondition: NotRequired[ActionConditionTypeDef],  # (1)
    LabelNameCondition: NotRequired[LabelNameConditionTypeDef],  # (2)
  1. See ActionConditionTypeDef
  2. See LabelNameConditionTypeDef

CookiesTypeDef#

# CookiesTypeDef usage example

from mypy_boto3_wafv2.type_defs import CookiesTypeDef

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

class CookiesTypeDef(TypedDict):
    MatchPattern: CookieMatchPatternTypeDef,  # (1)
    MatchScope: MapMatchScopeType,  # (2)
    OversizeHandling: OversizeHandlingType,  # (3)
  1. See CookieMatchPatternTypeDef
  2. See MapMatchScopeType
  3. See OversizeHandlingType

CreateIPSetRequestRequestTypeDef#

# CreateIPSetRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import CreateIPSetRequestRequestTypeDef

def get_value() -> CreateIPSetRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "IPAddressVersion": ...,
        "Addresses": ...,
    }
# CreateIPSetRequestRequestTypeDef 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#

# MobileSdkReleaseTypeDef usage example

from mypy_boto3_wafv2.type_defs import MobileSdkReleaseTypeDef

def get_value() -> MobileSdkReleaseTypeDef:
    return {
        "ReleaseVersion": ...,
    }
# MobileSdkReleaseTypeDef definition

class MobileSdkReleaseTypeDef(TypedDict):
    ReleaseVersion: NotRequired[str],
    Timestamp: NotRequired[datetime],
    ReleaseNotes: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (1)
  1. See TagTypeDef

TagInfoForResourceTypeDef#

# TagInfoForResourceTypeDef usage example

from mypy_boto3_wafv2.type_defs import TagInfoForResourceTypeDef

def get_value() -> TagInfoForResourceTypeDef:
    return {
        "ResourceARN": ...,
    }
# TagInfoForResourceTypeDef definition

class TagInfoForResourceTypeDef(TypedDict):
    ResourceARN: NotRequired[str],
    TagList: NotRequired[List[TagTypeDef]],  # (1)
  1. See TagTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "Tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateIPSetResponseTypeDef#

# CreateIPSetResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import CreateIPSetResponseTypeDef

def get_value() -> CreateIPSetResponseTypeDef:
    return {
        "Summary": ...,
        "ResponseMetadata": ...,
    }
# CreateIPSetResponseTypeDef definition

class CreateIPSetResponseTypeDef(TypedDict):
    Summary: IPSetSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IPSetSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListIPSetsResponseTypeDef#

# ListIPSetsResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListIPSetsResponseTypeDef

def get_value() -> ListIPSetsResponseTypeDef:
    return {
        "NextMarker": ...,
        "IPSets": ...,
        "ResponseMetadata": ...,
    }
# ListIPSetsResponseTypeDef definition

class ListIPSetsResponseTypeDef(TypedDict):
    NextMarker: str,
    IPSets: List[IPSetSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IPSetSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateRegexPatternSetRequestRequestTypeDef#

# CreateRegexPatternSetRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import CreateRegexPatternSetRequestRequestTypeDef

def get_value() -> CreateRegexPatternSetRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "RegularExpressionList": ...,
    }
# CreateRegexPatternSetRequestRequestTypeDef 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#

# RegexPatternSetTypeDef usage example

from mypy_boto3_wafv2.type_defs import RegexPatternSetTypeDef

def get_value() -> RegexPatternSetTypeDef:
    return {
        "Name": ...,
    }
# RegexPatternSetTypeDef definition

class RegexPatternSetTypeDef(TypedDict):
    Name: NotRequired[str],
    Id: NotRequired[str],
    ARN: NotRequired[str],
    Description: NotRequired[str],
    RegularExpressionList: NotRequired[List[RegexTypeDef]],  # (1)
  1. See RegexTypeDef

UpdateRegexPatternSetRequestRequestTypeDef#

# UpdateRegexPatternSetRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import UpdateRegexPatternSetRequestRequestTypeDef

def get_value() -> UpdateRegexPatternSetRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
        "RegularExpressionList": ...,
        "LockToken": ...,
    }
# UpdateRegexPatternSetRequestRequestTypeDef 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#

# CreateRegexPatternSetResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import CreateRegexPatternSetResponseTypeDef

def get_value() -> CreateRegexPatternSetResponseTypeDef:
    return {
        "Summary": ...,
        "ResponseMetadata": ...,
    }
# CreateRegexPatternSetResponseTypeDef definition

class CreateRegexPatternSetResponseTypeDef(TypedDict):
    Summary: RegexPatternSetSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RegexPatternSetSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListRegexPatternSetsResponseTypeDef#

# ListRegexPatternSetsResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListRegexPatternSetsResponseTypeDef

def get_value() -> ListRegexPatternSetsResponseTypeDef:
    return {
        "NextMarker": ...,
        "RegexPatternSets": ...,
        "ResponseMetadata": ...,
    }
# ListRegexPatternSetsResponseTypeDef definition

class ListRegexPatternSetsResponseTypeDef(TypedDict):
    NextMarker: str,
    RegexPatternSets: List[RegexPatternSetSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RegexPatternSetSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateRuleGroupResponseTypeDef#

# CreateRuleGroupResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import CreateRuleGroupResponseTypeDef

def get_value() -> CreateRuleGroupResponseTypeDef:
    return {
        "Summary": ...,
        "ResponseMetadata": ...,
    }
# CreateRuleGroupResponseTypeDef definition

class CreateRuleGroupResponseTypeDef(TypedDict):
    Summary: RuleGroupSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleGroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListRuleGroupsResponseTypeDef#

# ListRuleGroupsResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListRuleGroupsResponseTypeDef

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

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

CreateWebACLResponseTypeDef#

# CreateWebACLResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import CreateWebACLResponseTypeDef

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

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

ListWebACLsResponseTypeDef#

# ListWebACLsResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListWebACLsResponseTypeDef

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

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

CustomRequestHandlingTypeDef#

# CustomRequestHandlingTypeDef usage example

from mypy_boto3_wafv2.type_defs import CustomRequestHandlingTypeDef

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

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

CustomResponseTypeDef#

# CustomResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import CustomResponseTypeDef

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

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

GeoMatchStatementTypeDef#

# GeoMatchStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import GeoMatchStatementTypeDef

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

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

GetIPSetResponseTypeDef#

# GetIPSetResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetIPSetResponseTypeDef

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

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

GetRateBasedStatementManagedKeysResponseTypeDef#

# GetRateBasedStatementManagedKeysResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetRateBasedStatementManagedKeysResponseTypeDef

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

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

GetSampledRequestsRequestRequestTypeDef#

# GetSampledRequestsRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetSampledRequestsRequestRequestTypeDef

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

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

HTTPRequestTypeDef#

# HTTPRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import HTTPRequestTypeDef

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

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

HeadersTypeDef#

# HeadersTypeDef usage example

from mypy_boto3_wafv2.type_defs import HeadersTypeDef

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

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

IPSetReferenceStatementTypeDef#

# IPSetReferenceStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import IPSetReferenceStatementTypeDef

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

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

JsonBodyTypeDef#

# JsonBodyTypeDef usage example

from mypy_boto3_wafv2.type_defs import JsonBodyTypeDef

def get_value() -> JsonBodyTypeDef:
    return {
        "MatchPattern": ...,
        "MatchScope": ...,
    }
# JsonBodyTypeDef 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#

# ListAvailableManagedRuleGroupVersionsResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListAvailableManagedRuleGroupVersionsResponseTypeDef

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

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

ListAvailableManagedRuleGroupsResponseTypeDef#

# ListAvailableManagedRuleGroupsResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListAvailableManagedRuleGroupsResponseTypeDef

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

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

ListManagedRuleSetsResponseTypeDef#

# ListManagedRuleSetsResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListManagedRuleSetsResponseTypeDef

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

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

ListMobileSdkReleasesResponseTypeDef#

# ListMobileSdkReleasesResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListMobileSdkReleasesResponseTypeDef

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

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

RequestInspectionTypeDef#

# RequestInspectionTypeDef usage example

from mypy_boto3_wafv2.type_defs import RequestInspectionTypeDef

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

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

ManagedRuleSetTypeDef#

# ManagedRuleSetTypeDef usage example

from mypy_boto3_wafv2.type_defs import ManagedRuleSetTypeDef

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

class ManagedRuleSetTypeDef(TypedDict):
    Name: str,
    Id: str,
    ARN: str,
    Description: NotRequired[str],
    PublishedVersions: NotRequired[Dict[str, ManagedRuleSetVersionTypeDef]],  # (1)
    RecommendedVersion: NotRequired[str],
    LabelNamespace: NotRequired[str],
  1. See ManagedRuleSetVersionTypeDef

PutManagedRuleSetVersionsRequestRequestTypeDef#

# PutManagedRuleSetVersionsRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import PutManagedRuleSetVersionsRequestRequestTypeDef

def get_value() -> PutManagedRuleSetVersionsRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
        "LockToken": ...,
    }
# PutManagedRuleSetVersionsRequestRequestTypeDef 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#

# ResponseInspectionTypeDef usage example

from mypy_boto3_wafv2.type_defs import ResponseInspectionTypeDef

def get_value() -> ResponseInspectionTypeDef:
    return {
        "StatusCode": ...,
    }
# ResponseInspectionTypeDef 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

RateBasedStatementCustomKeyTypeDef#

# RateBasedStatementCustomKeyTypeDef usage example

from mypy_boto3_wafv2.type_defs import RateBasedStatementCustomKeyTypeDef

def get_value() -> RateBasedStatementCustomKeyTypeDef:
    return {
        "Header": ...,
    }
# RateBasedStatementCustomKeyTypeDef definition

class RateBasedStatementCustomKeyTypeDef(TypedDict):
    Header: NotRequired[RateLimitHeaderTypeDef],  # (1)
    Cookie: NotRequired[RateLimitCookieTypeDef],  # (2)
    QueryArgument: NotRequired[RateLimitQueryArgumentTypeDef],  # (3)
    QueryString: NotRequired[RateLimitQueryStringTypeDef],  # (4)
    HTTPMethod: NotRequired[Mapping[str, Any]],
    ForwardedIP: NotRequired[Mapping[str, Any]],
    IP: NotRequired[Mapping[str, Any]],
    LabelNamespace: NotRequired[RateLimitLabelNamespaceTypeDef],  # (5)
  1. See RateLimitHeaderTypeDef
  2. See RateLimitCookieTypeDef
  3. See RateLimitQueryArgumentTypeDef
  4. See RateLimitQueryStringTypeDef
  5. See RateLimitLabelNamespaceTypeDef

FilterTypeDef#

# FilterTypeDef usage example

from mypy_boto3_wafv2.type_defs import FilterTypeDef

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

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

GetMobileSdkReleaseResponseTypeDef#

# GetMobileSdkReleaseResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetMobileSdkReleaseResponseTypeDef

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

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListTagsForResourceResponseTypeDef

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

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

GetRegexPatternSetResponseTypeDef#

# GetRegexPatternSetResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetRegexPatternSetResponseTypeDef

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

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

AllowActionTypeDef#

# AllowActionTypeDef usage example

from mypy_boto3_wafv2.type_defs import AllowActionTypeDef

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

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

CaptchaActionTypeDef#

# CaptchaActionTypeDef usage example

from mypy_boto3_wafv2.type_defs import CaptchaActionTypeDef

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

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

ChallengeActionTypeDef#

# ChallengeActionTypeDef usage example

from mypy_boto3_wafv2.type_defs import ChallengeActionTypeDef

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

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

CountActionTypeDef#

# CountActionTypeDef usage example

from mypy_boto3_wafv2.type_defs import CountActionTypeDef

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

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

BlockActionTypeDef#

# BlockActionTypeDef usage example

from mypy_boto3_wafv2.type_defs import BlockActionTypeDef

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

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

SampledHTTPRequestTypeDef#

# SampledHTTPRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import SampledHTTPRequestTypeDef

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

class SampledHTTPRequestTypeDef(TypedDict):
    Request: HTTPRequestTypeDef,  # (1)
    Weight: int,
    Timestamp: NotRequired[datetime],
    Action: NotRequired[str],
    RuleNameWithinRuleGroup: NotRequired[str],
    RequestHeadersInserted: NotRequired[List[HTTPHeaderTypeDef]],  # (2)
    ResponseCodeSent: NotRequired[int],
    Labels: NotRequired[List[LabelTypeDef]],  # (3)
    CaptchaResponse: NotRequired[CaptchaResponseTypeDef],  # (4)
    ChallengeResponse: NotRequired[ChallengeResponseTypeDef],  # (5)
    OverriddenAction: NotRequired[str],
  1. See HTTPRequestTypeDef
  2. See HTTPHeaderTypeDef
  3. See LabelTypeDef
  4. See CaptchaResponseTypeDef
  5. See ChallengeResponseTypeDef

FieldToMatchTypeDef#

# FieldToMatchTypeDef usage example

from mypy_boto3_wafv2.type_defs import FieldToMatchTypeDef

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

class FieldToMatchTypeDef(TypedDict):
    SingleHeader: NotRequired[SingleHeaderTypeDef],  # (1)
    SingleQueryArgument: NotRequired[SingleQueryArgumentTypeDef],  # (2)
    AllQueryArguments: NotRequired[Mapping[str, Any]],
    UriPath: NotRequired[Mapping[str, Any]],
    QueryString: NotRequired[Mapping[str, Any]],
    Body: NotRequired[BodyTypeDef],  # (3)
    Method: NotRequired[Mapping[str, Any]],
    JsonBody: NotRequired[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#

# GetManagedRuleSetResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetManagedRuleSetResponseTypeDef

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

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

AWSManagedRulesATPRuleSetTypeDef#

# AWSManagedRulesATPRuleSetTypeDef usage example

from mypy_boto3_wafv2.type_defs import AWSManagedRulesATPRuleSetTypeDef

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

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

RateBasedStatementTypeDef#

# RateBasedStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import RateBasedStatementTypeDef

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

class RateBasedStatementTypeDef(TypedDict):
    Limit: int,
    AggregateKeyType: RateBasedStatementAggregateKeyTypeType,  # (1)
    ScopeDownStatement: NotRequired[StatementTypeDef],  # (2)
    ForwardedIPConfig: NotRequired[ForwardedIPConfigTypeDef],  # (3)
    CustomKeys: NotRequired[Sequence[RateBasedStatementCustomKeyTypeDef]],  # (4)
  1. See RateBasedStatementAggregateKeyTypeType
  2. See StatementTypeDef
  3. See ForwardedIPConfigTypeDef
  4. See RateBasedStatementCustomKeyTypeDef

LoggingFilterTypeDef#

# LoggingFilterTypeDef usage example

from mypy_boto3_wafv2.type_defs import LoggingFilterTypeDef

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

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

OverrideActionTypeDef#

# OverrideActionTypeDef usage example

from mypy_boto3_wafv2.type_defs import OverrideActionTypeDef

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

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

DefaultActionTypeDef#

# DefaultActionTypeDef usage example

from mypy_boto3_wafv2.type_defs import DefaultActionTypeDef

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

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

RuleActionTypeDef#

# RuleActionTypeDef usage example

from mypy_boto3_wafv2.type_defs import RuleActionTypeDef

def get_value() -> RuleActionTypeDef:
    return {
        "Block": ...,
    }
# RuleActionTypeDef 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#

# GetSampledRequestsResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetSampledRequestsResponseTypeDef

def get_value() -> GetSampledRequestsResponseTypeDef:
    return {
        "SampledRequests": ...,
        "PopulationSize": ...,
        "TimeWindow": ...,
        "ResponseMetadata": ...,
    }
# GetSampledRequestsResponseTypeDef 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#

# ByteMatchStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import ByteMatchStatementTypeDef

def get_value() -> ByteMatchStatementTypeDef:
    return {
        "SearchString": ...,
        "FieldToMatch": ...,
        "TextTransformations": ...,
        "PositionalConstraint": ...,
    }
# ByteMatchStatementTypeDef 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#

# RegexMatchStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import RegexMatchStatementTypeDef

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

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

RegexPatternSetReferenceStatementTypeDef#

# RegexPatternSetReferenceStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import RegexPatternSetReferenceStatementTypeDef

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

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

SizeConstraintStatementTypeDef#

# SizeConstraintStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import SizeConstraintStatementTypeDef

def get_value() -> SizeConstraintStatementTypeDef:
    return {
        "FieldToMatch": ...,
        "ComparisonOperator": ...,
        "Size": ...,
        "TextTransformations": ...,
    }
# SizeConstraintStatementTypeDef 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#

# SqliMatchStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import SqliMatchStatementTypeDef

def get_value() -> SqliMatchStatementTypeDef:
    return {
        "FieldToMatch": ...,
        "TextTransformations": ...,
    }
# SqliMatchStatementTypeDef 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#

# XssMatchStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import XssMatchStatementTypeDef

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

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

ManagedRuleGroupConfigTypeDef#

# ManagedRuleGroupConfigTypeDef usage example

from mypy_boto3_wafv2.type_defs import ManagedRuleGroupConfigTypeDef

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

class ManagedRuleGroupConfigTypeDef(TypedDict):
    LoginPath: NotRequired[str],
    PayloadType: NotRequired[PayloadTypeType],  # (1)
    UsernameField: NotRequired[UsernameFieldTypeDef],  # (2)
    PasswordField: NotRequired[PasswordFieldTypeDef],  # (3)
    AWSManagedRulesBotControlRuleSet: NotRequired[AWSManagedRulesBotControlRuleSetTypeDef],  # (4)
    AWSManagedRulesATPRuleSet: NotRequired[AWSManagedRulesATPRuleSetTypeDef],  # (5)
  1. See PayloadTypeType
  2. See UsernameFieldTypeDef
  3. See PasswordFieldTypeDef
  4. See AWSManagedRulesBotControlRuleSetTypeDef
  5. See AWSManagedRulesATPRuleSetTypeDef

LoggingConfigurationTypeDef#

# LoggingConfigurationTypeDef usage example

from mypy_boto3_wafv2.type_defs import LoggingConfigurationTypeDef

def get_value() -> LoggingConfigurationTypeDef:
    return {
        "ResourceArn": ...,
        "LogDestinationConfigs": ...,
    }
# LoggingConfigurationTypeDef 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#

# RuleActionOverrideTypeDef usage example

from mypy_boto3_wafv2.type_defs import RuleActionOverrideTypeDef

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

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

RuleSummaryTypeDef#

# RuleSummaryTypeDef usage example

from mypy_boto3_wafv2.type_defs import RuleSummaryTypeDef

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

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

RuleTypeDef#

# RuleTypeDef usage example

from mypy_boto3_wafv2.type_defs import RuleTypeDef

def get_value() -> RuleTypeDef:
    return {
        "Name": ...,
        "Priority": ...,
        "Statement": ...,
        "VisibilityConfig": ...,
    }
# RuleTypeDef 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#

# GetLoggingConfigurationResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetLoggingConfigurationResponseTypeDef

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

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

ListLoggingConfigurationsResponseTypeDef#

# ListLoggingConfigurationsResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import ListLoggingConfigurationsResponseTypeDef

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

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

PutLoggingConfigurationRequestRequestTypeDef#

# PutLoggingConfigurationRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import PutLoggingConfigurationRequestRequestTypeDef

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

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

PutLoggingConfigurationResponseTypeDef#

# PutLoggingConfigurationResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import PutLoggingConfigurationResponseTypeDef

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

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

ManagedRuleGroupStatementTypeDef#

# ManagedRuleGroupStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import ManagedRuleGroupStatementTypeDef

def get_value() -> ManagedRuleGroupStatementTypeDef:
    return {
        "VendorName": ...,
        "Name": ...,
    }
# ManagedRuleGroupStatementTypeDef 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#

# RuleGroupReferenceStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import RuleGroupReferenceStatementTypeDef

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

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

DescribeManagedRuleGroupResponseTypeDef#

# DescribeManagedRuleGroupResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import DescribeManagedRuleGroupResponseTypeDef

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

class DescribeManagedRuleGroupResponseTypeDef(TypedDict):
    VersionName: str,
    SnsTopicArn: str,
    Capacity: int,
    Rules: List[RuleSummaryTypeDef],  # (1)
    LabelNamespace: str,
    AvailableLabels: List[LabelSummaryTypeDef],  # (2)
    ConsumedLabels: List[LabelSummaryTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See RuleSummaryTypeDef
  2. See LabelSummaryTypeDef
  3. See LabelSummaryTypeDef
  4. See ResponseMetadataTypeDef

CheckCapacityRequestRequestTypeDef#

# CheckCapacityRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import CheckCapacityRequestRequestTypeDef

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

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

CreateRuleGroupRequestRequestTypeDef#

# CreateRuleGroupRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import CreateRuleGroupRequestRequestTypeDef

def get_value() -> CreateRuleGroupRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Capacity": ...,
        "VisibilityConfig": ...,
    }
# CreateRuleGroupRequestRequestTypeDef 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#

# CreateWebACLRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import CreateWebACLRequestRequestTypeDef

def get_value() -> CreateWebACLRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "DefaultAction": ...,
        "VisibilityConfig": ...,
    }
# CreateWebACLRequestRequestTypeDef 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]],
    AssociationConfig: NotRequired[AssociationConfigTypeDef],  # (9)
  1. See ScopeType
  2. See DefaultActionTypeDef
  3. See VisibilityConfigTypeDef
  4. See RuleTypeDef
  5. See TagTypeDef
  6. See CustomResponseBodyTypeDef
  7. See CaptchaConfigTypeDef
  8. See ChallengeConfigTypeDef
  9. See AssociationConfigTypeDef

RuleGroupTypeDef#

# RuleGroupTypeDef usage example

from mypy_boto3_wafv2.type_defs import RuleGroupTypeDef

def get_value() -> RuleGroupTypeDef:
    return {
        "Name": ...,
        "Id": ...,
        "Capacity": ...,
        "ARN": ...,
        "VisibilityConfig": ...,
    }
# RuleGroupTypeDef 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#

# UpdateRuleGroupRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import UpdateRuleGroupRequestRequestTypeDef

def get_value() -> UpdateRuleGroupRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
        "VisibilityConfig": ...,
        "LockToken": ...,
    }
# UpdateRuleGroupRequestRequestTypeDef 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#

# UpdateWebACLRequestRequestTypeDef usage example

from mypy_boto3_wafv2.type_defs import UpdateWebACLRequestRequestTypeDef

def get_value() -> UpdateWebACLRequestRequestTypeDef:
    return {
        "Name": ...,
        "Scope": ...,
        "Id": ...,
        "DefaultAction": ...,
        "VisibilityConfig": ...,
        "LockToken": ...,
    }
# UpdateWebACLRequestRequestTypeDef 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]],
    AssociationConfig: NotRequired[AssociationConfigTypeDef],  # (8)
  1. See ScopeType
  2. See DefaultActionTypeDef
  3. See VisibilityConfigTypeDef
  4. See RuleTypeDef
  5. See CustomResponseBodyTypeDef
  6. See CaptchaConfigTypeDef
  7. See ChallengeConfigTypeDef
  8. See AssociationConfigTypeDef

FirewallManagerStatementTypeDef#

# FirewallManagerStatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import FirewallManagerStatementTypeDef

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

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

StatementTypeDef#

# StatementTypeDef usage example

from mypy_boto3_wafv2.type_defs import StatementTypeDef

def get_value() -> StatementTypeDef:
    return {
        "ByteMatchStatement": ...,
    }
# StatementTypeDef 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#

# GetRuleGroupResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetRuleGroupResponseTypeDef

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

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

FirewallManagerRuleGroupTypeDef#

# FirewallManagerRuleGroupTypeDef usage example

from mypy_boto3_wafv2.type_defs import FirewallManagerRuleGroupTypeDef

def get_value() -> FirewallManagerRuleGroupTypeDef:
    return {
        "Name": ...,
        "Priority": ...,
        "FirewallManagerStatement": ...,
        "OverrideAction": ...,
        "VisibilityConfig": ...,
    }
# FirewallManagerRuleGroupTypeDef 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#

# WebACLTypeDef usage example

from mypy_boto3_wafv2.type_defs import WebACLTypeDef

def get_value() -> WebACLTypeDef:
    return {
        "Name": ...,
        "Id": ...,
        "ARN": ...,
        "DefaultAction": ...,
        "VisibilityConfig": ...,
    }
# WebACLTypeDef 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]],
    AssociationConfig: NotRequired[AssociationConfigTypeDef],  # (9)
  1. See DefaultActionTypeDef
  2. See RuleTypeDef
  3. See VisibilityConfigTypeDef
  4. See FirewallManagerRuleGroupTypeDef
  5. See FirewallManagerRuleGroupTypeDef
  6. See CustomResponseBodyTypeDef
  7. See CaptchaConfigTypeDef
  8. See ChallengeConfigTypeDef
  9. See AssociationConfigTypeDef

GetWebACLForResourceResponseTypeDef#

# GetWebACLForResourceResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetWebACLForResourceResponseTypeDef

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

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

GetWebACLResponseTypeDef#

# GetWebACLResponseTypeDef usage example

from mypy_boto3_wafv2.type_defs import GetWebACLResponseTypeDef

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

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