Skip to content

Type definitions#

Index > WAFV2 > Type definitions

Auto-generated documentation for WAFV2 type annotations stubs module types-aiobotocore-wafv2.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

APIKeySummaryTypeDef#

# APIKeySummaryTypeDef definition

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

AWSManagedRulesBotControlRuleSetTypeDef#

# AWSManagedRulesBotControlRuleSetTypeDef definition

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

ActionConditionTypeDef#

# ActionConditionTypeDef definition

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

AddressFieldTypeDef#

# AddressFieldTypeDef definition

class AddressFieldTypeDef(TypedDict):
    Identifier: str,

AndStatementTypeDef#

# AndStatementTypeDef definition

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

AssociateWebACLRequestRequestTypeDef#

# AssociateWebACLRequestRequestTypeDef definition

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

RequestBodyAssociatedResourceTypeConfigTypeDef#

# RequestBodyAssociatedResourceTypeConfigTypeDef definition

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

BodyTypeDef#

# BodyTypeDef definition

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

TextTransformationTypeDef#

# TextTransformationTypeDef definition

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

ImmunityTimePropertyTypeDef#

# ImmunityTimePropertyTypeDef definition

class ImmunityTimePropertyTypeDef(TypedDict):
    ImmunityTime: int,

CaptchaResponseTypeDef#

# CaptchaResponseTypeDef definition

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

ChallengeResponseTypeDef#

# ChallengeResponseTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

LabelNameConditionTypeDef#

# LabelNameConditionTypeDef definition

class LabelNameConditionTypeDef(TypedDict):
    LabelName: str,

CookieMatchPatternTypeDef#

# CookieMatchPatternTypeDef definition

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

CreateAPIKeyRequestRequestTypeDef#

# CreateAPIKeyRequestRequestTypeDef definition

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

TagTypeDef#

# TagTypeDef definition

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

IPSetSummaryTypeDef#

# IPSetSummaryTypeDef definition

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

RegexTypeDef#

# RegexTypeDef definition

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

RegexPatternSetSummaryTypeDef#

# RegexPatternSetSummaryTypeDef definition

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

CustomResponseBodyTypeDef#

# CustomResponseBodyTypeDef definition

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

VisibilityConfigTypeDef#

# VisibilityConfigTypeDef definition

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

RuleGroupSummaryTypeDef#

# RuleGroupSummaryTypeDef definition

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

WebACLSummaryTypeDef#

# WebACLSummaryTypeDef definition

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

CustomHTTPHeaderTypeDef#

# CustomHTTPHeaderTypeDef definition

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

DeleteFirewallManagerRuleGroupsRequestRequestTypeDef#

# DeleteFirewallManagerRuleGroupsRequestRequestTypeDef definition

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

DeleteIPSetRequestRequestTypeDef#

# DeleteIPSetRequestRequestTypeDef definition

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

DeleteLoggingConfigurationRequestRequestTypeDef#

# DeleteLoggingConfigurationRequestRequestTypeDef definition

class DeleteLoggingConfigurationRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DeletePermissionPolicyRequestRequestTypeDef#

# DeletePermissionPolicyRequestRequestTypeDef definition

class DeletePermissionPolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DeleteRegexPatternSetRequestRequestTypeDef#

# DeleteRegexPatternSetRequestRequestTypeDef definition

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

DeleteRuleGroupRequestRequestTypeDef#

# DeleteRuleGroupRequestRequestTypeDef definition

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

DeleteWebACLRequestRequestTypeDef#

# DeleteWebACLRequestRequestTypeDef definition

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

DescribeAllManagedProductsRequestRequestTypeDef#

# DescribeAllManagedProductsRequestRequestTypeDef definition

class DescribeAllManagedProductsRequestRequestTypeDef(TypedDict):
    Scope: ScopeType,  # (1)
  1. See ScopeType

ManagedProductDescriptorTypeDef#

# ManagedProductDescriptorTypeDef definition

class ManagedProductDescriptorTypeDef(TypedDict):
    VendorName: NotRequired[str],
    ManagedRuleSetName: NotRequired[str],
    ProductId: NotRequired[str],
    ProductLink: NotRequired[str],
    ProductTitle: NotRequired[str],
    ProductDescription: NotRequired[str],
    SnsTopicArn: NotRequired[str],
    IsVersioningSupported: NotRequired[bool],
    IsAdvancedManagedRuleSet: NotRequired[bool],

DescribeManagedProductsByVendorRequestRequestTypeDef#

# DescribeManagedProductsByVendorRequestRequestTypeDef definition

class DescribeManagedProductsByVendorRequestRequestTypeDef(TypedDict):
    VendorName: str,
    Scope: ScopeType,  # (1)
  1. See ScopeType

DescribeManagedRuleGroupRequestRequestTypeDef#

# DescribeManagedRuleGroupRequestRequestTypeDef definition

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

LabelSummaryTypeDef#

# LabelSummaryTypeDef definition

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

DisassociateWebACLRequestRequestTypeDef#

# DisassociateWebACLRequestRequestTypeDef definition

class DisassociateWebACLRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

EmailFieldTypeDef#

# EmailFieldTypeDef definition

class EmailFieldTypeDef(TypedDict):
    Identifier: str,

ExcludedRuleTypeDef#

# ExcludedRuleTypeDef definition

class ExcludedRuleTypeDef(TypedDict):
    Name: str,

HeaderOrderTypeDef#

# HeaderOrderTypeDef definition

class HeaderOrderTypeDef(TypedDict):
    OversizeHandling: OversizeHandlingType,  # (1)
  1. See OversizeHandlingType

SingleHeaderTypeDef#

# SingleHeaderTypeDef definition

class SingleHeaderTypeDef(TypedDict):
    Name: str,

SingleQueryArgumentTypeDef#

# SingleQueryArgumentTypeDef definition

class SingleQueryArgumentTypeDef(TypedDict):
    Name: str,

ForwardedIPConfigTypeDef#

# ForwardedIPConfigTypeDef definition

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

GenerateMobileSdkReleaseUrlRequestRequestTypeDef#

# GenerateMobileSdkReleaseUrlRequestRequestTypeDef definition

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

GetDecryptedAPIKeyRequestRequestTypeDef#

# GetDecryptedAPIKeyRequestRequestTypeDef definition

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

GetIPSetRequestRequestTypeDef#

# GetIPSetRequestRequestTypeDef definition

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

IPSetTypeDef#

# 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 definition

class GetLoggingConfigurationRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

GetManagedRuleSetRequestRequestTypeDef#

# GetManagedRuleSetRequestRequestTypeDef definition

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

GetMobileSdkReleaseRequestRequestTypeDef#

# GetMobileSdkReleaseRequestRequestTypeDef definition

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

GetPermissionPolicyRequestRequestTypeDef#

# GetPermissionPolicyRequestRequestTypeDef definition

class GetPermissionPolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

GetRateBasedStatementManagedKeysRequestRequestTypeDef#

# GetRateBasedStatementManagedKeysRequestRequestTypeDef definition

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

RateBasedStatementManagedKeysIPSetTypeDef#

# RateBasedStatementManagedKeysIPSetTypeDef definition

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

GetRegexPatternSetRequestRequestTypeDef#

# GetRegexPatternSetRequestRequestTypeDef definition

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

GetRuleGroupRequestRequestTypeDef#

# GetRuleGroupRequestRequestTypeDef definition

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

GetWebACLForResourceRequestRequestTypeDef#

# GetWebACLForResourceRequestRequestTypeDef definition

class GetWebACLForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

GetWebACLRequestRequestTypeDef#

# GetWebACLRequestRequestTypeDef definition

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

HTTPHeaderTypeDef#

# HTTPHeaderTypeDef definition

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

HeaderMatchPatternTypeDef#

# HeaderMatchPatternTypeDef definition

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

IPSetForwardedIPConfigTypeDef#

# IPSetForwardedIPConfigTypeDef definition

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

JsonMatchPatternTypeDef#

# JsonMatchPatternTypeDef definition

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

LabelMatchStatementTypeDef#

# LabelMatchStatementTypeDef definition

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

LabelTypeDef#

# LabelTypeDef definition

class LabelTypeDef(TypedDict):
    Name: str,

ListAPIKeysRequestRequestTypeDef#

# ListAPIKeysRequestRequestTypeDef definition

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

ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef#

# ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef definition

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

ManagedRuleGroupVersionTypeDef#

# ManagedRuleGroupVersionTypeDef definition

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

ListAvailableManagedRuleGroupsRequestRequestTypeDef#

# ListAvailableManagedRuleGroupsRequestRequestTypeDef definition

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

ManagedRuleGroupSummaryTypeDef#

# ManagedRuleGroupSummaryTypeDef definition

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

ListIPSetsRequestRequestTypeDef#

# ListIPSetsRequestRequestTypeDef definition

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

ListLoggingConfigurationsRequestRequestTypeDef#

# ListLoggingConfigurationsRequestRequestTypeDef definition

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

ListManagedRuleSetsRequestRequestTypeDef#

# ListManagedRuleSetsRequestRequestTypeDef definition

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

ManagedRuleSetSummaryTypeDef#

# 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 definition

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

ReleaseSummaryTypeDef#

# ReleaseSummaryTypeDef definition

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

ListRegexPatternSetsRequestRequestTypeDef#

# ListRegexPatternSetsRequestRequestTypeDef definition

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

ListResourcesForWebACLRequestRequestTypeDef#

# ListResourcesForWebACLRequestRequestTypeDef definition

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

ListRuleGroupsRequestRequestTypeDef#

# ListRuleGroupsRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

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

ListWebACLsRequestRequestTypeDef#

# ListWebACLsRequestRequestTypeDef definition

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

PasswordFieldTypeDef#

# PasswordFieldTypeDef definition

class PasswordFieldTypeDef(TypedDict):
    Identifier: str,

UsernameFieldTypeDef#

# UsernameFieldTypeDef definition

class UsernameFieldTypeDef(TypedDict):
    Identifier: str,

ManagedRuleSetVersionTypeDef#

# 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 definition

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

OrStatementTypeDef#

# OrStatementTypeDef definition

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

PhoneNumberFieldTypeDef#

# PhoneNumberFieldTypeDef definition

class PhoneNumberFieldTypeDef(TypedDict):
    Identifier: str,

VersionToPublishTypeDef#

# VersionToPublishTypeDef definition

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

PutPermissionPolicyRequestRequestTypeDef#

# PutPermissionPolicyRequestRequestTypeDef definition

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

RateLimitLabelNamespaceTypeDef#

# RateLimitLabelNamespaceTypeDef definition

class RateLimitLabelNamespaceTypeDef(TypedDict):
    Namespace: str,

ResponseInspectionBodyContainsTypeDef#

# ResponseInspectionBodyContainsTypeDef definition

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

ResponseInspectionHeaderTypeDef#

# ResponseInspectionHeaderTypeDef definition

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

ResponseInspectionJsonTypeDef#

# ResponseInspectionJsonTypeDef definition

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

ResponseInspectionStatusCodeTypeDef#

# ResponseInspectionStatusCodeTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateIPSetRequestRequestTypeDef#

# UpdateIPSetRequestRequestTypeDef definition

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

AssociationConfigTypeDef#

# AssociationConfigTypeDef definition

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

RateLimitCookieTypeDef#

# RateLimitCookieTypeDef definition

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

RateLimitHeaderTypeDef#

# RateLimitHeaderTypeDef definition

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

RateLimitQueryArgumentTypeDef#

# RateLimitQueryArgumentTypeDef definition

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

RateLimitQueryStringTypeDef#

# RateLimitQueryStringTypeDef definition

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

RateLimitUriPathTypeDef#

# RateLimitUriPathTypeDef definition

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

CaptchaConfigTypeDef#

# CaptchaConfigTypeDef definition

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

ChallengeConfigTypeDef#

# ChallengeConfigTypeDef definition

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

CheckCapacityResponseTypeDef#

# CheckCapacityResponseTypeDef definition

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

CreateAPIKeyResponseTypeDef#

# CreateAPIKeyResponseTypeDef definition

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

DeleteFirewallManagerRuleGroupsResponseTypeDef#

# DeleteFirewallManagerRuleGroupsResponseTypeDef definition

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

GenerateMobileSdkReleaseUrlResponseTypeDef#

# GenerateMobileSdkReleaseUrlResponseTypeDef definition

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

GetDecryptedAPIKeyResponseTypeDef#

# GetDecryptedAPIKeyResponseTypeDef definition

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

GetPermissionPolicyResponseTypeDef#

# GetPermissionPolicyResponseTypeDef definition

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

ListAPIKeysResponseTypeDef#

# ListAPIKeysResponseTypeDef definition

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

ListResourcesForWebACLResponseTypeDef#

# ListResourcesForWebACLResponseTypeDef definition

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

PutManagedRuleSetVersionsResponseTypeDef#

# PutManagedRuleSetVersionsResponseTypeDef definition

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

UpdateIPSetResponseTypeDef#

# UpdateIPSetResponseTypeDef definition

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

UpdateManagedRuleSetVersionExpiryDateResponseTypeDef#

# UpdateManagedRuleSetVersionExpiryDateResponseTypeDef definition

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

UpdateRegexPatternSetResponseTypeDef#

# UpdateRegexPatternSetResponseTypeDef definition

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

UpdateRuleGroupResponseTypeDef#

# UpdateRuleGroupResponseTypeDef definition

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

UpdateWebACLResponseTypeDef#

# UpdateWebACLResponseTypeDef definition

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

ConditionTypeDef#

# ConditionTypeDef definition

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

CookiesTypeDef#

# 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 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 definition

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

TagInfoForResourceTypeDef#

# TagInfoForResourceTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

CreateIPSetResponseTypeDef#

# CreateIPSetResponseTypeDef definition

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

ListIPSetsResponseTypeDef#

# ListIPSetsResponseTypeDef definition

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

CreateRegexPatternSetRequestRequestTypeDef#

# 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 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 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 definition

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

ListRegexPatternSetsResponseTypeDef#

# ListRegexPatternSetsResponseTypeDef definition

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

CreateRuleGroupResponseTypeDef#

# CreateRuleGroupResponseTypeDef definition

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

ListRuleGroupsResponseTypeDef#

# ListRuleGroupsResponseTypeDef definition

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

CreateWebACLResponseTypeDef#

# CreateWebACLResponseTypeDef definition

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

ListWebACLsResponseTypeDef#

# ListWebACLsResponseTypeDef definition

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

CustomRequestHandlingTypeDef#

# CustomRequestHandlingTypeDef definition

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

CustomResponseTypeDef#

# CustomResponseTypeDef definition

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

DescribeAllManagedProductsResponseTypeDef#

# DescribeAllManagedProductsResponseTypeDef definition

class DescribeAllManagedProductsResponseTypeDef(TypedDict):
    ManagedProducts: List[ManagedProductDescriptorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ManagedProductDescriptorTypeDef
  2. See ResponseMetadataTypeDef

DescribeManagedProductsByVendorResponseTypeDef#

# DescribeManagedProductsByVendorResponseTypeDef definition

class DescribeManagedProductsByVendorResponseTypeDef(TypedDict):
    ManagedProducts: List[ManagedProductDescriptorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ManagedProductDescriptorTypeDef
  2. See ResponseMetadataTypeDef

GeoMatchStatementTypeDef#

# GeoMatchStatementTypeDef definition

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

GetIPSetResponseTypeDef#

# GetIPSetResponseTypeDef definition

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

GetRateBasedStatementManagedKeysResponseTypeDef#

# GetRateBasedStatementManagedKeysResponseTypeDef definition

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

HTTPRequestTypeDef#

# 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 definition

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

IPSetReferenceStatementTypeDef#

# IPSetReferenceStatementTypeDef definition

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

JsonBodyTypeDef#

# 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 definition

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

ListAvailableManagedRuleGroupsResponseTypeDef#

# ListAvailableManagedRuleGroupsResponseTypeDef definition

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

ListManagedRuleSetsResponseTypeDef#

# ListManagedRuleSetsResponseTypeDef definition

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

ListMobileSdkReleasesResponseTypeDef#

# ListMobileSdkReleasesResponseTypeDef definition

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

RequestInspectionTypeDef#

# 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 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

RequestInspectionACFPTypeDef#

# RequestInspectionACFPTypeDef definition

class RequestInspectionACFPTypeDef(TypedDict):
    PayloadType: PayloadTypeType,  # (1)
    UsernameField: NotRequired[UsernameFieldTypeDef],  # (2)
    PasswordField: NotRequired[PasswordFieldTypeDef],  # (3)
    EmailField: NotRequired[EmailFieldTypeDef],  # (4)
    PhoneNumberFields: NotRequired[Sequence[PhoneNumberFieldTypeDef]],  # (5)
    AddressFields: NotRequired[Sequence[AddressFieldTypeDef]],  # (6)
  1. See PayloadTypeType
  2. See UsernameFieldTypeDef
  3. See PasswordFieldTypeDef
  4. See EmailFieldTypeDef
  5. See PhoneNumberFieldTypeDef
  6. See AddressFieldTypeDef

PutManagedRuleSetVersionsRequestRequestTypeDef#

# 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 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

TimeWindowTypeDef#

# TimeWindowTypeDef definition

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

UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef#

# UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef definition

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

RateBasedStatementCustomKeyTypeDef#

# 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)
    UriPath: NotRequired[RateLimitUriPathTypeDef],  # (6)
  1. See RateLimitHeaderTypeDef
  2. See RateLimitCookieTypeDef
  3. See RateLimitQueryArgumentTypeDef
  4. See RateLimitQueryStringTypeDef
  5. See RateLimitLabelNamespaceTypeDef
  6. See RateLimitUriPathTypeDef

FilterTypeDef#

# 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 definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

GetRegexPatternSetResponseTypeDef#

# GetRegexPatternSetResponseTypeDef definition

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

AllowActionTypeDef#

# AllowActionTypeDef definition

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

CaptchaActionTypeDef#

# CaptchaActionTypeDef definition

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

ChallengeActionTypeDef#

# ChallengeActionTypeDef definition

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

CountActionTypeDef#

# CountActionTypeDef definition

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

BlockActionTypeDef#

# BlockActionTypeDef definition

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

SampledHTTPRequestTypeDef#

# 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 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)
    HeaderOrder: NotRequired[HeaderOrderTypeDef],  # (7)
  1. See SingleHeaderTypeDef
  2. See SingleQueryArgumentTypeDef
  3. See BodyTypeDef
  4. See JsonBodyTypeDef
  5. See HeadersTypeDef
  6. See CookiesTypeDef
  7. See HeaderOrderTypeDef

GetManagedRuleSetResponseTypeDef#

# GetManagedRuleSetResponseTypeDef definition

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

AWSManagedRulesACFPRuleSetTypeDef#

# AWSManagedRulesACFPRuleSetTypeDef definition

class AWSManagedRulesACFPRuleSetTypeDef(TypedDict):
    CreationPath: str,
    RegistrationPagePath: str,
    RequestInspection: RequestInspectionACFPTypeDef,  # (1)
    ResponseInspection: NotRequired[ResponseInspectionTypeDef],  # (2)
    EnableRegexInPath: NotRequired[bool],
  1. See RequestInspectionACFPTypeDef
  2. See ResponseInspectionTypeDef

AWSManagedRulesATPRuleSetTypeDef#

# AWSManagedRulesATPRuleSetTypeDef definition

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

GetSampledRequestsRequestRequestTypeDef#

# GetSampledRequestsRequestRequestTypeDef definition

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

RateBasedStatementTypeDef#

# 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 definition

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

OverrideActionTypeDef#

# OverrideActionTypeDef definition

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

DefaultActionTypeDef#

# DefaultActionTypeDef definition

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

RuleActionTypeDef#

# 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 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 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 definition

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

RegexPatternSetReferenceStatementTypeDef#

# RegexPatternSetReferenceStatementTypeDef definition

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

SizeConstraintStatementTypeDef#

# 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 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 definition

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

ManagedRuleGroupConfigTypeDef#

# 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)
    AWSManagedRulesACFPRuleSet: NotRequired[AWSManagedRulesACFPRuleSetTypeDef],  # (6)
  1. See PayloadTypeType
  2. See UsernameFieldTypeDef
  3. See PasswordFieldTypeDef
  4. See AWSManagedRulesBotControlRuleSetTypeDef
  5. See AWSManagedRulesATPRuleSetTypeDef
  6. See AWSManagedRulesACFPRuleSetTypeDef

LoggingConfigurationTypeDef#

# 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 definition

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

RuleSummaryTypeDef#

# RuleSummaryTypeDef definition

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

RuleTypeDef#

# 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 definition

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

ListLoggingConfigurationsResponseTypeDef#

# ListLoggingConfigurationsResponseTypeDef definition

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

PutLoggingConfigurationRequestRequestTypeDef#

# PutLoggingConfigurationRequestRequestTypeDef definition

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

PutLoggingConfigurationResponseTypeDef#

# PutLoggingConfigurationResponseTypeDef definition

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

ManagedRuleGroupStatementTypeDef#

# 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 definition

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

DescribeManagedRuleGroupResponseTypeDef#

# 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 definition

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

CreateRuleGroupRequestRequestTypeDef#

# 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 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 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 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 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 definition

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

StatementTypeDef#

# 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 definition

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

FirewallManagerRuleGroupTypeDef#

# 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 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 definition

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

GetWebACLResponseTypeDef#

# GetWebACLResponseTypeDef definition

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