mypydantic.models.wafv2

   1# Model Generated: Wed Mar  1 11:15:22 2023
   2
   3from __future__ import annotations
   4
   5from datetime import datetime
   6from typing import (
   7    IO,
   8    Any,
   9    Dict,
  10    List,
  11    Literal,
  12    Mapping,
  13    Optional,
  14    Sequence,
  15    Union,
  16    Type,
  17)
  18
  19from botocore.response import StreamingBody
  20from pydantic import Field
  21
  22from mypydantic.models.base_model import BaseModel
  23
  24
  25class AWSManagedRulesBotControlRuleSet(BaseModel):
  26    inspection_level: Literal["COMMON", "TARGETED"] = Field(alias="InspectionLevel")
  27
  28
  29class ActionCondition(BaseModel):
  30    action: Literal[
  31        "ALLOW", "BLOCK", "CAPTCHA", "CHALLENGE", "COUNT", "EXCLUDED_AS_COUNT"
  32    ] = Field(alias="Action")
  33
  34
  35class AndStatement(BaseModel):
  36    statements: Sequence[Statement] = Field(alias="Statements")
  37
  38
  39class AssociateWebACLRequest(BaseModel):
  40    web_acl_arn: str = Field(alias="WebACLArn")
  41    resource_arn: str = Field(alias="ResourceArn")
  42
  43
  44class Body(BaseModel):
  45    oversize_handling: Optional[Literal["CONTINUE", "MATCH", "NO_MATCH"]] = Field(
  46        default=None, alias="OversizeHandling"
  47    )
  48
  49
  50class TextTransformation(BaseModel):
  51    priority: int = Field(alias="Priority")
  52    type: Literal[
  53        "BASE64_DECODE",
  54        "BASE64_DECODE_EXT",
  55        "CMD_LINE",
  56        "COMPRESS_WHITE_SPACE",
  57        "CSS_DECODE",
  58        "ESCAPE_SEQ_DECODE",
  59        "HEX_DECODE",
  60        "HTML_ENTITY_DECODE",
  61        "JS_DECODE",
  62        "LOWERCASE",
  63        "MD5",
  64        "NONE",
  65        "NORMALIZE_PATH",
  66        "NORMALIZE_PATH_WIN",
  67        "REMOVE_NULLS",
  68        "REPLACE_COMMENTS",
  69        "REPLACE_NULLS",
  70        "SQL_HEX_DECODE",
  71        "URL_DECODE",
  72        "URL_DECODE_UNI",
  73        "UTF8_TO_UNICODE",
  74    ] = Field(alias="Type")
  75
  76
  77class ImmunityTimeProperty(BaseModel):
  78    immunity_time: int = Field(alias="ImmunityTime")
  79
  80
  81class CaptchaResponse(BaseModel):
  82    response_code: Optional[int] = Field(default=None, alias="ResponseCode")
  83    solve_timestamp: Optional[int] = Field(default=None, alias="SolveTimestamp")
  84    failure_reason: Optional[
  85        Literal[
  86            "TOKEN_DOMAIN_MISMATCH", "TOKEN_EXPIRED", "TOKEN_INVALID", "TOKEN_MISSING"
  87        ]
  88    ] = Field(default=None, alias="FailureReason")
  89
  90
  91class ChallengeResponse(BaseModel):
  92    response_code: Optional[int] = Field(default=None, alias="ResponseCode")
  93    solve_timestamp: Optional[int] = Field(default=None, alias="SolveTimestamp")
  94    failure_reason: Optional[
  95        Literal[
  96            "TOKEN_DOMAIN_MISMATCH", "TOKEN_EXPIRED", "TOKEN_INVALID", "TOKEN_MISSING"
  97        ]
  98    ] = Field(default=None, alias="FailureReason")
  99
 100
 101class ResponseMetadata(BaseModel):
 102    request_id: str = Field(alias="RequestId")
 103    host_id: str = Field(alias="HostId")
 104    http_status_code: int = Field(alias="HTTPStatusCode")
 105    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
 106    retry_attempts: int = Field(alias="RetryAttempts")
 107
 108
 109class LabelNameCondition(BaseModel):
 110    label_name: str = Field(alias="LabelName")
 111
 112
 113class CookieMatchPattern(BaseModel):
 114    all: Optional[Mapping[str, Any]] = Field(default=None, alias="All")
 115    included_cookies: Optional[Sequence[str]] = Field(
 116        default=None, alias="IncludedCookies"
 117    )
 118    excluded_cookies: Optional[Sequence[str]] = Field(
 119        default=None, alias="ExcludedCookies"
 120    )
 121
 122
 123class Tag(BaseModel):
 124    key: str = Field(alias="Key")
 125    value: str = Field(alias="Value")
 126
 127
 128class IPSetSummary(BaseModel):
 129    name: Optional[str] = Field(default=None, alias="Name")
 130    id: Optional[str] = Field(default=None, alias="Id")
 131    description: Optional[str] = Field(default=None, alias="Description")
 132    lock_token: Optional[str] = Field(default=None, alias="LockToken")
 133    arn: Optional[str] = Field(default=None, alias="ARN")
 134
 135
 136class Regex(BaseModel):
 137    regex_string: Optional[str] = Field(default=None, alias="RegexString")
 138
 139
 140class RegexPatternSetSummary(BaseModel):
 141    name: Optional[str] = Field(default=None, alias="Name")
 142    id: Optional[str] = Field(default=None, alias="Id")
 143    description: Optional[str] = Field(default=None, alias="Description")
 144    lock_token: Optional[str] = Field(default=None, alias="LockToken")
 145    arn: Optional[str] = Field(default=None, alias="ARN")
 146
 147
 148class CustomResponseBody(BaseModel):
 149    content_type: Literal["APPLICATION_JSON", "TEXT_HTML", "TEXT_PLAIN"] = Field(
 150        alias="ContentType"
 151    )
 152    content: str = Field(alias="Content")
 153
 154
 155class VisibilityConfig(BaseModel):
 156    sampled_requests_enabled: bool = Field(alias="SampledRequestsEnabled")
 157    cloud_watch_metrics_enabled: bool = Field(alias="CloudWatchMetricsEnabled")
 158    metric_name: str = Field(alias="MetricName")
 159
 160
 161class RuleGroupSummary(BaseModel):
 162    name: Optional[str] = Field(default=None, alias="Name")
 163    id: Optional[str] = Field(default=None, alias="Id")
 164    description: Optional[str] = Field(default=None, alias="Description")
 165    lock_token: Optional[str] = Field(default=None, alias="LockToken")
 166    arn: Optional[str] = Field(default=None, alias="ARN")
 167
 168
 169class WebACLSummary(BaseModel):
 170    name: Optional[str] = Field(default=None, alias="Name")
 171    id: Optional[str] = Field(default=None, alias="Id")
 172    description: Optional[str] = Field(default=None, alias="Description")
 173    lock_token: Optional[str] = Field(default=None, alias="LockToken")
 174    arn: Optional[str] = Field(default=None, alias="ARN")
 175
 176
 177class CustomHTTPHeader(BaseModel):
 178    name: str = Field(alias="Name")
 179    value: str = Field(alias="Value")
 180
 181
 182class DeleteFirewallManagerRuleGroupsRequest(BaseModel):
 183    web_acl_arn: str = Field(alias="WebACLArn")
 184    web_acl_lock_token: str = Field(alias="WebACLLockToken")
 185
 186
 187class DeleteIPSetRequest(BaseModel):
 188    name: str = Field(alias="Name")
 189    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 190    id: str = Field(alias="Id")
 191    lock_token: str = Field(alias="LockToken")
 192
 193
 194class DeleteLoggingConfigurationRequest(BaseModel):
 195    resource_arn: str = Field(alias="ResourceArn")
 196
 197
 198class DeletePermissionPolicyRequest(BaseModel):
 199    resource_arn: str = Field(alias="ResourceArn")
 200
 201
 202class DeleteRegexPatternSetRequest(BaseModel):
 203    name: str = Field(alias="Name")
 204    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 205    id: str = Field(alias="Id")
 206    lock_token: str = Field(alias="LockToken")
 207
 208
 209class DeleteRuleGroupRequest(BaseModel):
 210    name: str = Field(alias="Name")
 211    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 212    id: str = Field(alias="Id")
 213    lock_token: str = Field(alias="LockToken")
 214
 215
 216class DeleteWebACLRequest(BaseModel):
 217    name: str = Field(alias="Name")
 218    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 219    id: str = Field(alias="Id")
 220    lock_token: str = Field(alias="LockToken")
 221
 222
 223class DescribeManagedRuleGroupRequest(BaseModel):
 224    vendor_name: str = Field(alias="VendorName")
 225    name: str = Field(alias="Name")
 226    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 227    version_name: Optional[str] = Field(default=None, alias="VersionName")
 228
 229
 230class LabelSummary(BaseModel):
 231    name: Optional[str] = Field(default=None, alias="Name")
 232
 233
 234class DisassociateWebACLRequest(BaseModel):
 235    resource_arn: str = Field(alias="ResourceArn")
 236
 237
 238class ExcludedRule(BaseModel):
 239    name: str = Field(alias="Name")
 240
 241
 242class SingleHeader(BaseModel):
 243    name: str = Field(alias="Name")
 244
 245
 246class SingleQueryArgument(BaseModel):
 247    name: str = Field(alias="Name")
 248
 249
 250class ForwardedIPConfig(BaseModel):
 251    header_name: str = Field(alias="HeaderName")
 252    fallback_behavior: Literal["MATCH", "NO_MATCH"] = Field(alias="FallbackBehavior")
 253
 254
 255class GenerateMobileSdkReleaseUrlRequest(BaseModel):
 256    platform: Literal["ANDROID", "IOS"] = Field(alias="Platform")
 257    release_version: str = Field(alias="ReleaseVersion")
 258
 259
 260class GetIPSetRequest(BaseModel):
 261    name: str = Field(alias="Name")
 262    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 263    id: str = Field(alias="Id")
 264
 265
 266class IPSet(BaseModel):
 267    name: str = Field(alias="Name")
 268    id: str = Field(alias="Id")
 269    arn: str = Field(alias="ARN")
 270    ip_address_version: Literal["IPV4", "IPV6"] = Field(alias="IPAddressVersion")
 271    addresses: List[str] = Field(alias="Addresses")
 272    description: Optional[str] = Field(default=None, alias="Description")
 273
 274
 275class GetLoggingConfigurationRequest(BaseModel):
 276    resource_arn: str = Field(alias="ResourceArn")
 277
 278
 279class GetManagedRuleSetRequest(BaseModel):
 280    name: str = Field(alias="Name")
 281    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 282    id: str = Field(alias="Id")
 283
 284
 285class GetMobileSdkReleaseRequest(BaseModel):
 286    platform: Literal["ANDROID", "IOS"] = Field(alias="Platform")
 287    release_version: str = Field(alias="ReleaseVersion")
 288
 289
 290class GetPermissionPolicyRequest(BaseModel):
 291    resource_arn: str = Field(alias="ResourceArn")
 292
 293
 294class GetRateBasedStatementManagedKeysRequest(BaseModel):
 295    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 296    web_acl_name: str = Field(alias="WebACLName")
 297    web_acl_id: str = Field(alias="WebACLId")
 298    rule_name: str = Field(alias="RuleName")
 299    rule_group_rule_name: Optional[str] = Field(default=None, alias="RuleGroupRuleName")
 300
 301
 302class RateBasedStatementManagedKeysIPSet(BaseModel):
 303    ip_address_version: Optional[Literal["IPV4", "IPV6"]] = Field(
 304        default=None, alias="IPAddressVersion"
 305    )
 306    addresses: Optional[List[str]] = Field(default=None, alias="Addresses")
 307
 308
 309class GetRegexPatternSetRequest(BaseModel):
 310    name: str = Field(alias="Name")
 311    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 312    id: str = Field(alias="Id")
 313
 314
 315class GetRuleGroupRequest(BaseModel):
 316    name: Optional[str] = Field(default=None, alias="Name")
 317    scope: Optional[Literal["CLOUDFRONT", "REGIONAL"]] = Field(
 318        default=None, alias="Scope"
 319    )
 320    id: Optional[str] = Field(default=None, alias="Id")
 321    arn: Optional[str] = Field(default=None, alias="ARN")
 322
 323
 324class TimeWindow(BaseModel):
 325    start_time: Union[datetime, str] = Field(alias="StartTime")
 326    end_time: Union[datetime, str] = Field(alias="EndTime")
 327
 328
 329class GetWebACLForResourceRequest(BaseModel):
 330    resource_arn: str = Field(alias="ResourceArn")
 331
 332
 333class GetWebACLRequest(BaseModel):
 334    name: str = Field(alias="Name")
 335    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 336    id: str = Field(alias="Id")
 337
 338
 339class HTTPHeader(BaseModel):
 340    name: Optional[str] = Field(default=None, alias="Name")
 341    value: Optional[str] = Field(default=None, alias="Value")
 342
 343
 344class HeaderMatchPattern(BaseModel):
 345    all: Optional[Mapping[str, Any]] = Field(default=None, alias="All")
 346    included_headers: Optional[Sequence[str]] = Field(
 347        default=None, alias="IncludedHeaders"
 348    )
 349    excluded_headers: Optional[Sequence[str]] = Field(
 350        default=None, alias="ExcludedHeaders"
 351    )
 352
 353
 354class IPSetForwardedIPConfig(BaseModel):
 355    header_name: str = Field(alias="HeaderName")
 356    fallback_behavior: Literal["MATCH", "NO_MATCH"] = Field(alias="FallbackBehavior")
 357    position: Literal["ANY", "FIRST", "LAST"] = Field(alias="Position")
 358
 359
 360class JsonMatchPattern(BaseModel):
 361    all: Optional[Mapping[str, Any]] = Field(default=None, alias="All")
 362    included_paths: Optional[Sequence[str]] = Field(default=None, alias="IncludedPaths")
 363
 364
 365class LabelMatchStatement(BaseModel):
 366    scope: Literal["LABEL", "NAMESPACE"] = Field(alias="Scope")
 367    key: str = Field(alias="Key")
 368
 369
 370class Label(BaseModel):
 371    name: str = Field(alias="Name")
 372
 373
 374class ListAvailableManagedRuleGroupVersionsRequest(BaseModel):
 375    vendor_name: str = Field(alias="VendorName")
 376    name: str = Field(alias="Name")
 377    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 378    next_marker: Optional[str] = Field(default=None, alias="NextMarker")
 379    limit: Optional[int] = Field(default=None, alias="Limit")
 380
 381
 382class ManagedRuleGroupVersion(BaseModel):
 383    name: Optional[str] = Field(default=None, alias="Name")
 384    last_update_timestamp: Optional[datetime] = Field(
 385        default=None, alias="LastUpdateTimestamp"
 386    )
 387
 388
 389class ListAvailableManagedRuleGroupsRequest(BaseModel):
 390    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 391    next_marker: Optional[str] = Field(default=None, alias="NextMarker")
 392    limit: Optional[int] = Field(default=None, alias="Limit")
 393
 394
 395class ManagedRuleGroupSummary(BaseModel):
 396    vendor_name: Optional[str] = Field(default=None, alias="VendorName")
 397    name: Optional[str] = Field(default=None, alias="Name")
 398    versioning_supported: Optional[bool] = Field(
 399        default=None, alias="VersioningSupported"
 400    )
 401    description: Optional[str] = Field(default=None, alias="Description")
 402
 403
 404class ListIPSetsRequest(BaseModel):
 405    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 406    next_marker: Optional[str] = Field(default=None, alias="NextMarker")
 407    limit: Optional[int] = Field(default=None, alias="Limit")
 408
 409
 410class ListLoggingConfigurationsRequest(BaseModel):
 411    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 412    next_marker: Optional[str] = Field(default=None, alias="NextMarker")
 413    limit: Optional[int] = Field(default=None, alias="Limit")
 414
 415
 416class ListManagedRuleSetsRequest(BaseModel):
 417    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 418    next_marker: Optional[str] = Field(default=None, alias="NextMarker")
 419    limit: Optional[int] = Field(default=None, alias="Limit")
 420
 421
 422class ManagedRuleSetSummary(BaseModel):
 423    name: Optional[str] = Field(default=None, alias="Name")
 424    id: Optional[str] = Field(default=None, alias="Id")
 425    description: Optional[str] = Field(default=None, alias="Description")
 426    lock_token: Optional[str] = Field(default=None, alias="LockToken")
 427    arn: Optional[str] = Field(default=None, alias="ARN")
 428    label_namespace: Optional[str] = Field(default=None, alias="LabelNamespace")
 429
 430
 431class ListMobileSdkReleasesRequest(BaseModel):
 432    platform: Literal["ANDROID", "IOS"] = Field(alias="Platform")
 433    next_marker: Optional[str] = Field(default=None, alias="NextMarker")
 434    limit: Optional[int] = Field(default=None, alias="Limit")
 435
 436
 437class ReleaseSummary(BaseModel):
 438    release_version: Optional[str] = Field(default=None, alias="ReleaseVersion")
 439    timestamp: Optional[datetime] = Field(default=None, alias="Timestamp")
 440
 441
 442class ListRegexPatternSetsRequest(BaseModel):
 443    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 444    next_marker: Optional[str] = Field(default=None, alias="NextMarker")
 445    limit: Optional[int] = Field(default=None, alias="Limit")
 446
 447
 448class ListResourcesForWebACLRequest(BaseModel):
 449    web_acl_arn: str = Field(alias="WebACLArn")
 450    resource_type: Optional[
 451        Literal[
 452            "API_GATEWAY",
 453            "APPLICATION_LOAD_BALANCER",
 454            "APPSYNC",
 455            "APP_RUNNER_SERVICE",
 456            "COGNITO_USER_POOL",
 457        ]
 458    ] = Field(default=None, alias="ResourceType")
 459
 460
 461class ListRuleGroupsRequest(BaseModel):
 462    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 463    next_marker: Optional[str] = Field(default=None, alias="NextMarker")
 464    limit: Optional[int] = Field(default=None, alias="Limit")
 465
 466
 467class ListTagsForResourceRequest(BaseModel):
 468    resource_arn: str = Field(alias="ResourceARN")
 469    next_marker: Optional[str] = Field(default=None, alias="NextMarker")
 470    limit: Optional[int] = Field(default=None, alias="Limit")
 471
 472
 473class ListWebACLsRequest(BaseModel):
 474    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 475    next_marker: Optional[str] = Field(default=None, alias="NextMarker")
 476    limit: Optional[int] = Field(default=None, alias="Limit")
 477
 478
 479class PasswordField(BaseModel):
 480    identifier: str = Field(alias="Identifier")
 481
 482
 483class UsernameField(BaseModel):
 484    identifier: str = Field(alias="Identifier")
 485
 486
 487class ManagedRuleSetVersion(BaseModel):
 488    associated_rule_group_arn: Optional[str] = Field(
 489        default=None, alias="AssociatedRuleGroupArn"
 490    )
 491    capacity: Optional[int] = Field(default=None, alias="Capacity")
 492    forecasted_lifetime: Optional[int] = Field(default=None, alias="ForecastedLifetime")
 493    publish_timestamp: Optional[datetime] = Field(
 494        default=None, alias="PublishTimestamp"
 495    )
 496    last_update_timestamp: Optional[datetime] = Field(
 497        default=None, alias="LastUpdateTimestamp"
 498    )
 499    expiry_timestamp: Optional[datetime] = Field(default=None, alias="ExpiryTimestamp")
 500
 501
 502class NotStatement(BaseModel):
 503    statement: Dict[str, Any] = Field(alias="Statement")
 504
 505
 506class OrStatement(BaseModel):
 507    statements: Sequence[Statement] = Field(alias="Statements")
 508
 509
 510class VersionToPublish(BaseModel):
 511    associated_rule_group_arn: Optional[str] = Field(
 512        default=None, alias="AssociatedRuleGroupArn"
 513    )
 514    forecasted_lifetime: Optional[int] = Field(default=None, alias="ForecastedLifetime")
 515
 516
 517class PutPermissionPolicyRequest(BaseModel):
 518    resource_arn: str = Field(alias="ResourceArn")
 519    policy: str = Field(alias="Policy")
 520
 521
 522class ResponseInspectionBodyContains(BaseModel):
 523    success_strings: Sequence[str] = Field(alias="SuccessStrings")
 524    failure_strings: Sequence[str] = Field(alias="FailureStrings")
 525
 526
 527class ResponseInspectionHeader(BaseModel):
 528    name: str = Field(alias="Name")
 529    success_values: Sequence[str] = Field(alias="SuccessValues")
 530    failure_values: Sequence[str] = Field(alias="FailureValues")
 531
 532
 533class ResponseInspectionJson(BaseModel):
 534    identifier: str = Field(alias="Identifier")
 535    success_values: Sequence[str] = Field(alias="SuccessValues")
 536    failure_values: Sequence[str] = Field(alias="FailureValues")
 537
 538
 539class ResponseInspectionStatusCode(BaseModel):
 540    success_codes: Sequence[int] = Field(alias="SuccessCodes")
 541    failure_codes: Sequence[int] = Field(alias="FailureCodes")
 542
 543
 544class UntagResourceRequest(BaseModel):
 545    resource_arn: str = Field(alias="ResourceARN")
 546    tag_keys: Sequence[str] = Field(alias="TagKeys")
 547
 548
 549class UpdateIPSetRequest(BaseModel):
 550    name: str = Field(alias="Name")
 551    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 552    id: str = Field(alias="Id")
 553    addresses: Sequence[str] = Field(alias="Addresses")
 554    lock_token: str = Field(alias="LockToken")
 555    description: Optional[str] = Field(default=None, alias="Description")
 556
 557
 558class UpdateManagedRuleSetVersionExpiryDateRequest(BaseModel):
 559    name: str = Field(alias="Name")
 560    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 561    id: str = Field(alias="Id")
 562    lock_token: str = Field(alias="LockToken")
 563    version_to_expire: str = Field(alias="VersionToExpire")
 564    expiry_timestamp: Union[datetime, str] = Field(alias="ExpiryTimestamp")
 565
 566
 567class CaptchaConfig(BaseModel):
 568    immunity_time_property: Optional[ImmunityTimeProperty] = Field(
 569        default=None, alias="ImmunityTimeProperty"
 570    )
 571
 572
 573class ChallengeConfig(BaseModel):
 574    immunity_time_property: Optional[ImmunityTimeProperty] = Field(
 575        default=None, alias="ImmunityTimeProperty"
 576    )
 577
 578
 579class CheckCapacityResponse(BaseModel):
 580    capacity: int = Field(alias="Capacity")
 581    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 582
 583
 584class DeleteFirewallManagerRuleGroupsResponse(BaseModel):
 585    next_web_acl_lock_token: str = Field(alias="NextWebACLLockToken")
 586    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 587
 588
 589class GenerateMobileSdkReleaseUrlResponse(BaseModel):
 590    url: str = Field(alias="Url")
 591    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 592
 593
 594class GetPermissionPolicyResponse(BaseModel):
 595    policy: str = Field(alias="Policy")
 596    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 597
 598
 599class ListResourcesForWebACLResponse(BaseModel):
 600    resource_arns: List[str] = Field(alias="ResourceArns")
 601    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 602
 603
 604class PutManagedRuleSetVersionsResponse(BaseModel):
 605    next_lock_token: str = Field(alias="NextLockToken")
 606    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 607
 608
 609class UpdateIPSetResponse(BaseModel):
 610    next_lock_token: str = Field(alias="NextLockToken")
 611    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 612
 613
 614class UpdateManagedRuleSetVersionExpiryDateResponse(BaseModel):
 615    expiring_version: str = Field(alias="ExpiringVersion")
 616    expiry_timestamp: datetime = Field(alias="ExpiryTimestamp")
 617    next_lock_token: str = Field(alias="NextLockToken")
 618    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 619
 620
 621class UpdateRegexPatternSetResponse(BaseModel):
 622    next_lock_token: str = Field(alias="NextLockToken")
 623    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 624
 625
 626class UpdateRuleGroupResponse(BaseModel):
 627    next_lock_token: str = Field(alias="NextLockToken")
 628    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 629
 630
 631class UpdateWebACLResponse(BaseModel):
 632    next_lock_token: str = Field(alias="NextLockToken")
 633    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 634
 635
 636class Condition(BaseModel):
 637    action_condition: Optional[ActionCondition] = Field(
 638        default=None, alias="ActionCondition"
 639    )
 640    label_name_condition: Optional[LabelNameCondition] = Field(
 641        default=None, alias="LabelNameCondition"
 642    )
 643
 644
 645class Cookies(BaseModel):
 646    match_pattern: CookieMatchPattern = Field(alias="MatchPattern")
 647    match_scope: Literal["ALL", "KEY", "VALUE"] = Field(alias="MatchScope")
 648    oversize_handling: Literal["CONTINUE", "MATCH", "NO_MATCH"] = Field(
 649        alias="OversizeHandling"
 650    )
 651
 652
 653class CreateIPSetRequest(BaseModel):
 654    name: str = Field(alias="Name")
 655    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 656    ip_address_version: Literal["IPV4", "IPV6"] = Field(alias="IPAddressVersion")
 657    addresses: Sequence[str] = Field(alias="Addresses")
 658    description: Optional[str] = Field(default=None, alias="Description")
 659    tags: Optional[Sequence[Tag]] = Field(default=None, alias="Tags")
 660
 661
 662class MobileSdkRelease(BaseModel):
 663    release_version: Optional[str] = Field(default=None, alias="ReleaseVersion")
 664    timestamp: Optional[datetime] = Field(default=None, alias="Timestamp")
 665    release_notes: Optional[str] = Field(default=None, alias="ReleaseNotes")
 666    tags: Optional[List[Tag]] = Field(default=None, alias="Tags")
 667
 668
 669class TagInfoForResource(BaseModel):
 670    resource_arn: Optional[str] = Field(default=None, alias="ResourceARN")
 671    tag_list: Optional[List[Tag]] = Field(default=None, alias="TagList")
 672
 673
 674class TagResourceRequest(BaseModel):
 675    resource_arn: str = Field(alias="ResourceARN")
 676    tags: Sequence[Tag] = Field(alias="Tags")
 677
 678
 679class CreateIPSetResponse(BaseModel):
 680    summary: IPSetSummary = Field(alias="Summary")
 681    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 682
 683
 684class ListIPSetsResponse(BaseModel):
 685    next_marker: str = Field(alias="NextMarker")
 686    ip_sets: List[IPSetSummary] = Field(alias="IPSets")
 687    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 688
 689
 690class CreateRegexPatternSetRequest(BaseModel):
 691    name: str = Field(alias="Name")
 692    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 693    regular_expression_list: Sequence[Regex] = Field(alias="RegularExpressionList")
 694    description: Optional[str] = Field(default=None, alias="Description")
 695    tags: Optional[Sequence[Tag]] = Field(default=None, alias="Tags")
 696
 697
 698class RegexPatternSet(BaseModel):
 699    name: Optional[str] = Field(default=None, alias="Name")
 700    id: Optional[str] = Field(default=None, alias="Id")
 701    arn: Optional[str] = Field(default=None, alias="ARN")
 702    description: Optional[str] = Field(default=None, alias="Description")
 703    regular_expression_list: Optional[List[Regex]] = Field(
 704        default=None, alias="RegularExpressionList"
 705    )
 706
 707
 708class UpdateRegexPatternSetRequest(BaseModel):
 709    name: str = Field(alias="Name")
 710    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
 711    id: str = Field(alias="Id")
 712    regular_expression_list: Sequence[Regex] = Field(alias="RegularExpressionList")
 713    lock_token: str = Field(alias="LockToken")
 714    description: Optional[str] = Field(default=None, alias="Description")
 715
 716
 717class CreateRegexPatternSetResponse(BaseModel):
 718    summary: RegexPatternSetSummary = Field(alias="Summary")
 719    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 720
 721
 722class ListRegexPatternSetsResponse(BaseModel):
 723    next_marker: str = Field(alias="NextMarker")
 724    regex_pattern_sets: List[RegexPatternSetSummary] = Field(alias="RegexPatternSets")
 725    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 726
 727
 728class CreateRuleGroupResponse(BaseModel):
 729    summary: RuleGroupSummary = Field(alias="Summary")
 730    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 731
 732
 733class ListRuleGroupsResponse(BaseModel):
 734    next_marker: str = Field(alias="NextMarker")
 735    rule_groups: List[RuleGroupSummary] = Field(alias="RuleGroups")
 736    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 737
 738
 739class CreateWebACLResponse(BaseModel):
 740    summary: WebACLSummary = Field(alias="Summary")
 741    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 742
 743
 744class ListWebACLsResponse(BaseModel):
 745    next_marker: str = Field(alias="NextMarker")
 746    web_acls: List[WebACLSummary] = Field(alias="WebACLs")
 747    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
 748
 749
 750class CustomRequestHandling(BaseModel):
 751    insert_headers: Sequence[CustomHTTPHeader] = Field(alias="InsertHeaders")
 752
 753
 754class CustomResponse(BaseModel):
 755    response_code: int = Field(alias="ResponseCode")
 756    custom_response_body_key: Optional[str] = Field(
 757        default=None, alias="CustomResponseBodyKey"
 758    )
 759    response_headers: Optional[Sequence[CustomHTTPHeader]] = Field(
 760        default=None, alias="ResponseHeaders"
 761    )
 762
 763
 764class GeoMatchStatement(BaseModel):
 765    country_codes: Optional[
 766        Sequence[
 767            Literal[
 768                "AD",
 769                "AE",
 770                "AF",
 771                "AG",
 772                "AI",
 773                "AL",
 774                "AM",
 775                "AO",
 776                "AQ",
 777                "AR",
 778                "AS",
 779                "AT",
 780                "AU",
 781                "AW",
 782                "AX",
 783                "AZ",
 784                "BA",
 785                "BB",
 786                "BD",
 787                "BE",
 788                "BF",
 789                "BG",
 790                "BH",
 791                "BI",
 792                "BJ",
 793                "BL",
 794                "BM",
 795                "BN",
 796                "BO",
 797                "BQ",
 798                "BR",
 799                "BS",
 800                "BT",
 801                "BV",
 802                "BW",
 803                "BY",
 804                "BZ",
 805                "CA",
 806                "CC",
 807                "CD",
 808                "CF",
 809                "CG",
 810                "CH",
 811                "CI",
 812                "CK",
 813                "CL",
 814                "CM",
 815                "CN",
 816                "CO",
 817                "CR",
 818                "CU",
 819                "CV",
 820                "CW",
 821                "CX",
 822                "CY",
 823                "CZ",
 824                "DE",
 825                "DJ",
 826                "DK",
 827                "DM",
 828                "DO",
 829                "DZ",
 830                "EC",
 831                "EE",
 832                "EG",
 833                "EH",
 834                "ER",
 835                "ES",
 836                "ET",
 837                "FI",
 838                "FJ",
 839                "FK",
 840                "FM",
 841                "FO",
 842                "FR",
 843                "GA",
 844                "GB",
 845                "GD",
 846                "GE",
 847                "GF",
 848                "GG",
 849                "GH",
 850                "GI",
 851                "GL",
 852                "GM",
 853                "GN",
 854                "GP",
 855                "GQ",
 856                "GR",
 857                "GS",
 858                "GT",
 859                "GU",
 860                "GW",
 861                "GY",
 862                "HK",
 863                "HM",
 864                "HN",
 865                "HR",
 866                "HT",
 867                "HU",
 868                "ID",
 869                "IE",
 870                "IL",
 871                "IM",
 872                "IN",
 873                "Type[IO]",
 874                "IQ",
 875                "IR",
 876                "IS",
 877                "IT",
 878                "JE",
 879                "JM",
 880                "JO",
 881                "JP",
 882                "KE",
 883                "KG",
 884                "KH",
 885                "KI",
 886                "KM",
 887                "KN",
 888                "KP",
 889                "KR",
 890                "KW",
 891                "KY",
 892                "KZ",
 893                "LA",
 894                "LB",
 895                "LC",
 896                "LI",
 897                "LK",
 898                "LR",
 899                "LS",
 900                "LT",
 901                "LU",
 902                "LV",
 903                "LY",
 904                "MA",
 905                "MC",
 906                "MD",
 907                "ME",
 908                "MF",
 909                "MG",
 910                "MH",
 911                "MK",
 912                "ML",
 913                "MM",
 914                "MN",
 915                "MO",
 916                "MP",
 917                "MQ",
 918                "MR",
 919                "MS",
 920                "MT",
 921                "MU",
 922                "MV",
 923                "MW",
 924                "MX",
 925                "MY",
 926                "MZ",
 927                "NA",
 928                "NC",
 929                "NE",
 930                "NF",
 931                "NG",
 932                "NI",
 933                "NL",
 934                "NO",
 935                "NP",
 936                "NR",
 937                "NU",
 938                "NZ",
 939                "OM",
 940                "PA",
 941                "PE",
 942                "PF",
 943                "PG",
 944                "PH",
 945                "PK",
 946                "PL",
 947                "PM",
 948                "PN",
 949                "PR",
 950                "PS",
 951                "PT",
 952                "PW",
 953                "PY",
 954                "QA",
 955                "RE",
 956                "RO",
 957                "RS",
 958                "RU",
 959                "RW",
 960                "SA",
 961                "SB",
 962                "SC",
 963                "SD",
 964                "SE",
 965                "SG",
 966                "SH",
 967                "SI",
 968                "SJ",
 969                "SK",
 970                "SL",
 971                "SM",
 972                "SN",
 973                "SO",
 974                "SR",
 975                "SS",
 976                "ST",
 977                "SV",
 978                "SX",
 979                "SY",
 980                "SZ",
 981                "TC",
 982                "TD",
 983                "TF",
 984                "TG",
 985                "TH",
 986                "TJ",
 987                "TK",
 988                "TL",
 989                "TM",
 990                "TN",
 991                "TO",
 992                "TR",
 993                "TT",
 994                "TV",
 995                "TW",
 996                "TZ",
 997                "UA",
 998                "UG",
 999                "UM",
1000                "US",
1001                "UY",
1002                "UZ",
1003                "VA",
1004                "VC",
1005                "VE",
1006                "VG",
1007                "VI",
1008                "VN",
1009                "VU",
1010                "WF",
1011                "WS",
1012                "XK",
1013                "YE",
1014                "YT",
1015                "ZA",
1016                "ZM",
1017                "ZW",
1018            ]
1019        ]
1020    ] = Field(default=None, alias="CountryCodes")
1021    forwarded_ip_config: Optional[ForwardedIPConfig] = Field(
1022        default=None, alias="ForwardedIPConfig"
1023    )
1024
1025
1026class RateBasedStatement(BaseModel):
1027    limit: int = Field(alias="Limit")
1028    aggregate_key_type: Literal["FORWARDED_IP", "IP"] = Field(alias="AggregateKeyType")
1029    scope_down_statement: Optional[Statement] = Field(
1030        default=None, alias="ScopeDownStatement"
1031    )
1032    forwarded_ip_config: Optional[ForwardedIPConfig] = Field(
1033        default=None, alias="ForwardedIPConfig"
1034    )
1035
1036
1037class GetIPSetResponse(BaseModel):
1038    ip_set: IPSet = Field(alias="IPSet")
1039    lock_token: str = Field(alias="LockToken")
1040    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1041
1042
1043class GetRateBasedStatementManagedKeysResponse(BaseModel):
1044    managed_keys_ip_v4: RateBasedStatementManagedKeysIPSet = Field(
1045        alias="ManagedKeysIPV4"
1046    )
1047    managed_keys_ip_v6: RateBasedStatementManagedKeysIPSet = Field(
1048        alias="ManagedKeysIPV6"
1049    )
1050    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1051
1052
1053class GetSampledRequestsRequest(BaseModel):
1054    web_acl_arn: str = Field(alias="WebAclArn")
1055    rule_metric_name: str = Field(alias="RuleMetricName")
1056    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
1057    time_window: TimeWindow = Field(alias="TimeWindow")
1058    max_items: int = Field(alias="MaxItems")
1059
1060
1061class HTTPRequest(BaseModel):
1062    client_ip: Optional[str] = Field(default=None, alias="ClientIP")
1063    country: Optional[str] = Field(default=None, alias="Country")
1064    uri: Optional[str] = Field(default=None, alias="URI")
1065    method: Optional[str] = Field(default=None, alias="Method")
1066    http_version: Optional[str] = Field(default=None, alias="HTTPVersion")
1067    headers: Optional[List[HTTPHeader]] = Field(default=None, alias="Headers")
1068
1069
1070class Headers(BaseModel):
1071    match_pattern: HeaderMatchPattern = Field(alias="MatchPattern")
1072    match_scope: Literal["ALL", "KEY", "VALUE"] = Field(alias="MatchScope")
1073    oversize_handling: Literal["CONTINUE", "MATCH", "NO_MATCH"] = Field(
1074        alias="OversizeHandling"
1075    )
1076
1077
1078class IPSetReferenceStatement(BaseModel):
1079    arn: str = Field(alias="ARN")
1080    ip_set_forwarded_ip_config: Optional[IPSetForwardedIPConfig] = Field(
1081        default=None, alias="IPSetForwardedIPConfig"
1082    )
1083
1084
1085class JsonBody(BaseModel):
1086    match_pattern: JsonMatchPattern = Field(alias="MatchPattern")
1087    match_scope: Literal["ALL", "KEY", "VALUE"] = Field(alias="MatchScope")
1088    invalid_fallback_behavior: Optional[
1089        Literal["EVALUATE_AS_STRING", "MATCH", "NO_MATCH"]
1090    ] = Field(default=None, alias="InvalidFallbackBehavior")
1091    oversize_handling: Optional[Literal["CONTINUE", "MATCH", "NO_MATCH"]] = Field(
1092        default=None, alias="OversizeHandling"
1093    )
1094
1095
1096class ListAvailableManagedRuleGroupVersionsResponse(BaseModel):
1097    next_marker: str = Field(alias="NextMarker")
1098    versions: List[ManagedRuleGroupVersion] = Field(alias="Versions")
1099    current_default_version: str = Field(alias="CurrentDefaultVersion")
1100    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1101
1102
1103class ListAvailableManagedRuleGroupsResponse(BaseModel):
1104    next_marker: str = Field(alias="NextMarker")
1105    managed_rule_groups: List[ManagedRuleGroupSummary] = Field(
1106        alias="ManagedRuleGroups"
1107    )
1108    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1109
1110
1111class ListManagedRuleSetsResponse(BaseModel):
1112    next_marker: str = Field(alias="NextMarker")
1113    managed_rule_sets: List[ManagedRuleSetSummary] = Field(alias="ManagedRuleSets")
1114    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1115
1116
1117class ListMobileSdkReleasesResponse(BaseModel):
1118    release_summaries: List[ReleaseSummary] = Field(alias="ReleaseSummaries")
1119    next_marker: str = Field(alias="NextMarker")
1120    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1121
1122
1123class RequestInspection(BaseModel):
1124    payload_type: Literal["FORM_ENCODED", "JSON"] = Field(alias="PayloadType")
1125    username_field: UsernameField = Field(alias="UsernameField")
1126    password_field: PasswordField = Field(alias="PasswordField")
1127
1128
1129class ManagedRuleSet(BaseModel):
1130    name: str = Field(alias="Name")
1131    id: str = Field(alias="Id")
1132    arn: str = Field(alias="ARN")
1133    description: Optional[str] = Field(default=None, alias="Description")
1134    published_versions: Optional[Dict[str, ManagedRuleSetVersion]] = Field(
1135        default=None, alias="PublishedVersions"
1136    )
1137    recommended_version: Optional[str] = Field(default=None, alias="RecommendedVersion")
1138    label_namespace: Optional[str] = Field(default=None, alias="LabelNamespace")
1139
1140
1141class PutManagedRuleSetVersionsRequest(BaseModel):
1142    name: str = Field(alias="Name")
1143    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
1144    id: str = Field(alias="Id")
1145    lock_token: str = Field(alias="LockToken")
1146    recommended_version: Optional[str] = Field(default=None, alias="RecommendedVersion")
1147    versions_to_publish: Optional[Mapping[str, VersionToPublish]] = Field(
1148        default=None, alias="VersionsToPublish"
1149    )
1150
1151
1152class ResponseInspection(BaseModel):
1153    status_code: Optional[ResponseInspectionStatusCode] = Field(
1154        default=None, alias="StatusCode"
1155    )
1156    header: Optional[ResponseInspectionHeader] = Field(default=None, alias="Header")
1157    body_contains: Optional[ResponseInspectionBodyContains] = Field(
1158        default=None, alias="BodyContains"
1159    )
1160    json_: Optional[ResponseInspectionJson] = Field(default=None, alias="Json")
1161
1162
1163class Filter(BaseModel):
1164    behavior: Literal["DROP", "KEEP"] = Field(alias="Behavior")
1165    requirement: Literal["MEETS_ALL", "MEETS_ANY"] = Field(alias="Requirement")
1166    conditions: List[Condition] = Field(alias="Conditions")
1167
1168
1169class GetMobileSdkReleaseResponse(BaseModel):
1170    mobile_sdk_release: MobileSdkRelease = Field(alias="MobileSdkRelease")
1171    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1172
1173
1174class ListTagsForResourceResponse(BaseModel):
1175    next_marker: str = Field(alias="NextMarker")
1176    tag_info_for_resource: TagInfoForResource = Field(alias="TagInfoForResource")
1177    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1178
1179
1180class GetRegexPatternSetResponse(BaseModel):
1181    regex_pattern_set: RegexPatternSet = Field(alias="RegexPatternSet")
1182    lock_token: str = Field(alias="LockToken")
1183    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1184
1185
1186class AllowAction(BaseModel):
1187    custom_request_handling: Optional[CustomRequestHandling] = Field(
1188        default=None, alias="CustomRequestHandling"
1189    )
1190
1191
1192class CaptchaAction(BaseModel):
1193    custom_request_handling: Optional[CustomRequestHandling] = Field(
1194        default=None, alias="CustomRequestHandling"
1195    )
1196
1197
1198class ChallengeAction(BaseModel):
1199    custom_request_handling: Optional[CustomRequestHandling] = Field(
1200        default=None, alias="CustomRequestHandling"
1201    )
1202
1203
1204class CountAction(BaseModel):
1205    custom_request_handling: Optional[CustomRequestHandling] = Field(
1206        default=None, alias="CustomRequestHandling"
1207    )
1208
1209
1210class BlockAction(BaseModel):
1211    custom_response: Optional[CustomResponse] = Field(
1212        default=None, alias="CustomResponse"
1213    )
1214
1215
1216class SampledHTTPRequest(BaseModel):
1217    request: HTTPRequest = Field(alias="Request")
1218    weight: int = Field(alias="Weight")
1219    timestamp: Optional[datetime] = Field(default=None, alias="Timestamp")
1220    action: Optional[str] = Field(default=None, alias="Action")
1221    rule_name_within_rule_group: Optional[str] = Field(
1222        default=None, alias="RuleNameWithinRuleGroup"
1223    )
1224    request_headers_inserted: Optional[List[HTTPHeader]] = Field(
1225        default=None, alias="RequestHeadersInserted"
1226    )
1227    response_code_sent: Optional[int] = Field(default=None, alias="ResponseCodeSent")
1228    labels: Optional[List[Label]] = Field(default=None, alias="Labels")
1229    captcha_response: Optional[CaptchaResponse] = Field(
1230        default=None, alias="CaptchaResponse"
1231    )
1232    challenge_response: Optional[ChallengeResponse] = Field(
1233        default=None, alias="ChallengeResponse"
1234    )
1235    overridden_action: Optional[str] = Field(default=None, alias="OverriddenAction")
1236
1237
1238class FieldToMatch(BaseModel):
1239    single_header: Optional[SingleHeader] = Field(default=None, alias="SingleHeader")
1240    single_query_argument: Optional[SingleQueryArgument] = Field(
1241        default=None, alias="SingleQueryArgument"
1242    )
1243    all_query_arguments: Optional[Mapping[str, Any]] = Field(
1244        default=None, alias="AllQueryArguments"
1245    )
1246    uri_path: Optional[Mapping[str, Any]] = Field(default=None, alias="UriPath")
1247    query_string: Optional[Mapping[str, Any]] = Field(default=None, alias="QueryString")
1248    body: Optional[Body] = Field(default=None, alias="Body")
1249    method: Optional[Mapping[str, Any]] = Field(default=None, alias="Method")
1250    json_body: Optional[JsonBody] = Field(default=None, alias="JsonBody")
1251    headers: Optional[Headers] = Field(default=None, alias="Headers")
1252    cookies: Optional[Cookies] = Field(default=None, alias="Cookies")
1253
1254
1255class GetManagedRuleSetResponse(BaseModel):
1256    managed_rule_set: ManagedRuleSet = Field(alias="ManagedRuleSet")
1257    lock_token: str = Field(alias="LockToken")
1258    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1259
1260
1261class AWSManagedRulesATPRuleSet(BaseModel):
1262    login_path: str = Field(alias="LoginPath")
1263    request_inspection: Optional[RequestInspection] = Field(
1264        default=None, alias="RequestInspection"
1265    )
1266    response_inspection: Optional[ResponseInspection] = Field(
1267        default=None, alias="ResponseInspection"
1268    )
1269
1270
1271class LoggingFilter(BaseModel):
1272    filters: List[Filter] = Field(alias="Filters")
1273    default_behavior: Literal["DROP", "KEEP"] = Field(alias="DefaultBehavior")
1274
1275
1276class OverrideAction(BaseModel):
1277    count: Optional[CountAction] = Field(default=None, alias="Count")
1278    none_: Optional[Mapping[str, Any]] = Field(default=None, alias="None")
1279
1280
1281class DefaultAction(BaseModel):
1282    block: Optional[BlockAction] = Field(default=None, alias="Block")
1283    allow: Optional[AllowAction] = Field(default=None, alias="Allow")
1284
1285
1286class RuleAction(BaseModel):
1287    block: Optional[BlockAction] = Field(default=None, alias="Block")
1288    allow: Optional[AllowAction] = Field(default=None, alias="Allow")
1289    count: Optional[CountAction] = Field(default=None, alias="Count")
1290    captcha: Optional[CaptchaAction] = Field(default=None, alias="Captcha")
1291    challenge: Optional[ChallengeAction] = Field(default=None, alias="Challenge")
1292
1293
1294class GetSampledRequestsResponse(BaseModel):
1295    sampled_requests: List[SampledHTTPRequest] = Field(alias="SampledRequests")
1296    population_size: int = Field(alias="PopulationSize")
1297    time_window: TimeWindow = Field(alias="TimeWindow")
1298    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1299
1300
1301class ByteMatchStatement(BaseModel):
1302    search_string: Union[str, bytes, Type[IO[Any]], Type[StreamingBody]] = Field(
1303        alias="SearchString"
1304    )
1305    field_to_match: FieldToMatch = Field(alias="FieldToMatch")
1306    text_transformations: Sequence[TextTransformation] = Field(
1307        alias="TextTransformations"
1308    )
1309    positional_constraint: Literal[
1310        "CONTAINS", "CONTAINS_WORD", "ENDS_WITH", "EXACTLY", "STARTS_WITH"
1311    ] = Field(alias="PositionalConstraint")
1312
1313
1314class RegexMatchStatement(BaseModel):
1315    regex_string: str = Field(alias="RegexString")
1316    field_to_match: FieldToMatch = Field(alias="FieldToMatch")
1317    text_transformations: Sequence[TextTransformation] = Field(
1318        alias="TextTransformations"
1319    )
1320
1321
1322class RegexPatternSetReferenceStatement(BaseModel):
1323    arn: str = Field(alias="ARN")
1324    field_to_match: FieldToMatch = Field(alias="FieldToMatch")
1325    text_transformations: Sequence[TextTransformation] = Field(
1326        alias="TextTransformations"
1327    )
1328
1329
1330class SizeConstraintStatement(BaseModel):
1331    field_to_match: FieldToMatch = Field(alias="FieldToMatch")
1332    comparison_operator: Literal["EQ", "GE", "GT", "LE", "LT", "NE"] = Field(
1333        alias="ComparisonOperator"
1334    )
1335    size: int = Field(alias="Size")
1336    text_transformations: Sequence[TextTransformation] = Field(
1337        alias="TextTransformations"
1338    )
1339
1340
1341class SqliMatchStatement(BaseModel):
1342    field_to_match: FieldToMatch = Field(alias="FieldToMatch")
1343    text_transformations: Sequence[TextTransformation] = Field(
1344        alias="TextTransformations"
1345    )
1346    sensitivity_level: Optional[Literal["HIGH", "LOW"]] = Field(
1347        default=None, alias="SensitivityLevel"
1348    )
1349
1350
1351class XssMatchStatement(BaseModel):
1352    field_to_match: FieldToMatch = Field(alias="FieldToMatch")
1353    text_transformations: Sequence[TextTransformation] = Field(
1354        alias="TextTransformations"
1355    )
1356
1357
1358class ManagedRuleGroupConfig(BaseModel):
1359    login_path: Optional[str] = Field(default=None, alias="LoginPath")
1360    payload_type: Optional[Literal["FORM_ENCODED", "JSON"]] = Field(
1361        default=None, alias="PayloadType"
1362    )
1363    username_field: Optional[UsernameField] = Field(default=None, alias="UsernameField")
1364    password_field: Optional[PasswordField] = Field(default=None, alias="PasswordField")
1365    aws_managed_rules_bot_control_rule_set: Optional[
1366        AWSManagedRulesBotControlRuleSet
1367    ] = Field(default=None, alias="AWSManagedRulesBotControlRuleSet")
1368    aws_managed_rules_atp_rule_set: Optional[AWSManagedRulesATPRuleSet] = Field(
1369        default=None, alias="AWSManagedRulesATPRuleSet"
1370    )
1371
1372
1373class LoggingConfiguration(BaseModel):
1374    resource_arn: str = Field(alias="ResourceArn")
1375    log_destination_configs: List[str] = Field(alias="LogDestinationConfigs")
1376    redacted_fields: Optional[List[FieldToMatch]] = Field(
1377        default=None, alias="RedactedFields"
1378    )
1379    managed_by_firewall_manager: Optional[bool] = Field(
1380        default=None, alias="ManagedByFirewallManager"
1381    )
1382    logging_filter: Optional[LoggingFilter] = Field(default=None, alias="LoggingFilter")
1383
1384
1385class RuleActionOverride(BaseModel):
1386    name: str = Field(alias="Name")
1387    action_to_use: RuleAction = Field(alias="ActionToUse")
1388
1389
1390class RuleSummary(BaseModel):
1391    name: Optional[str] = Field(default=None, alias="Name")
1392    action: Optional[RuleAction] = Field(default=None, alias="Action")
1393
1394
1395class Rule(BaseModel):
1396    name: str = Field(alias="Name")
1397    priority: int = Field(alias="Priority")
1398    statement: Statement = Field(alias="Statement")
1399    visibility_config: VisibilityConfig = Field(alias="VisibilityConfig")
1400    action: Optional[RuleAction] = Field(default=None, alias="Action")
1401    override_action: Optional[OverrideAction] = Field(
1402        default=None, alias="OverrideAction"
1403    )
1404    rule_labels: Optional[Sequence[Label]] = Field(default=None, alias="RuleLabels")
1405    captcha_config: Optional[CaptchaConfig] = Field(default=None, alias="CaptchaConfig")
1406    challenge_config: Optional[ChallengeConfig] = Field(
1407        default=None, alias="ChallengeConfig"
1408    )
1409
1410
1411class GetLoggingConfigurationResponse(BaseModel):
1412    logging_configuration: LoggingConfiguration = Field(alias="LoggingConfiguration")
1413    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1414
1415
1416class ListLoggingConfigurationsResponse(BaseModel):
1417    logging_configurations: List[LoggingConfiguration] = Field(
1418        alias="LoggingConfigurations"
1419    )
1420    next_marker: str = Field(alias="NextMarker")
1421    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1422
1423
1424class PutLoggingConfigurationRequest(BaseModel):
1425    logging_configuration: LoggingConfiguration = Field(alias="LoggingConfiguration")
1426
1427
1428class PutLoggingConfigurationResponse(BaseModel):
1429    logging_configuration: LoggingConfiguration = Field(alias="LoggingConfiguration")
1430    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1431
1432
1433class ManagedRuleGroupStatement(BaseModel):
1434    vendor_name: str = Field(alias="VendorName")
1435    name: str = Field(alias="Name")
1436    version: Optional[str] = Field(default=None, alias="Version")
1437    excluded_rules: Optional[Sequence[ExcludedRule]] = Field(
1438        default=None, alias="ExcludedRules"
1439    )
1440    scope_down_statement: Optional[Statement] = Field(
1441        default=None, alias="ScopeDownStatement"
1442    )
1443    managed_rule_group_configs: Optional[Sequence[ManagedRuleGroupConfig]] = Field(
1444        default=None, alias="ManagedRuleGroupConfigs"
1445    )
1446    rule_action_overrides: Optional[Sequence[RuleActionOverride]] = Field(
1447        default=None, alias="RuleActionOverrides"
1448    )
1449
1450
1451class RuleGroupReferenceStatement(BaseModel):
1452    arn: str = Field(alias="ARN")
1453    excluded_rules: Optional[Sequence[ExcludedRule]] = Field(
1454        default=None, alias="ExcludedRules"
1455    )
1456    rule_action_overrides: Optional[Sequence[RuleActionOverride]] = Field(
1457        default=None, alias="RuleActionOverrides"
1458    )
1459
1460
1461class DescribeManagedRuleGroupResponse(BaseModel):
1462    version_name: str = Field(alias="VersionName")
1463    sns_topic_arn: str = Field(alias="SnsTopicArn")
1464    capacity: int = Field(alias="Capacity")
1465    rules: List[RuleSummary] = Field(alias="Rules")
1466    label_namespace: str = Field(alias="LabelNamespace")
1467    available_labels: List[LabelSummary] = Field(alias="AvailableLabels")
1468    consumed_labels: List[LabelSummary] = Field(alias="ConsumedLabels")
1469    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1470
1471
1472class CheckCapacityRequest(BaseModel):
1473    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
1474    rules: Sequence[Rule] = Field(alias="Rules")
1475
1476
1477class CreateRuleGroupRequest(BaseModel):
1478    name: str = Field(alias="Name")
1479    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
1480    capacity: int = Field(alias="Capacity")
1481    visibility_config: VisibilityConfig = Field(alias="VisibilityConfig")
1482    description: Optional[str] = Field(default=None, alias="Description")
1483    rules: Optional[Sequence[Rule]] = Field(default=None, alias="Rules")
1484    tags: Optional[Sequence[Tag]] = Field(default=None, alias="Tags")
1485    custom_response_bodies: Optional[Mapping[str, CustomResponseBody]] = Field(
1486        default=None, alias="CustomResponseBodies"
1487    )
1488
1489
1490class CreateWebACLRequest(BaseModel):
1491    name: str = Field(alias="Name")
1492    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
1493    default_action: DefaultAction = Field(alias="DefaultAction")
1494    visibility_config: VisibilityConfig = Field(alias="VisibilityConfig")
1495    description: Optional[str] = Field(default=None, alias="Description")
1496    rules: Optional[Sequence[Rule]] = Field(default=None, alias="Rules")
1497    tags: Optional[Sequence[Tag]] = Field(default=None, alias="Tags")
1498    custom_response_bodies: Optional[Mapping[str, CustomResponseBody]] = Field(
1499        default=None, alias="CustomResponseBodies"
1500    )
1501    captcha_config: Optional[CaptchaConfig] = Field(default=None, alias="CaptchaConfig")
1502    challenge_config: Optional[ChallengeConfig] = Field(
1503        default=None, alias="ChallengeConfig"
1504    )
1505    token_domains: Optional[Sequence[str]] = Field(default=None, alias="TokenDomains")
1506
1507
1508class RuleGroup(BaseModel):
1509    name: str = Field(alias="Name")
1510    id: str = Field(alias="Id")
1511    capacity: int = Field(alias="Capacity")
1512    arn: str = Field(alias="ARN")
1513    visibility_config: VisibilityConfig = Field(alias="VisibilityConfig")
1514    description: Optional[str] = Field(default=None, alias="Description")
1515    rules: Optional[List[Rule]] = Field(default=None, alias="Rules")
1516    label_namespace: Optional[str] = Field(default=None, alias="LabelNamespace")
1517    custom_response_bodies: Optional[Dict[str, CustomResponseBody]] = Field(
1518        default=None, alias="CustomResponseBodies"
1519    )
1520    available_labels: Optional[List[LabelSummary]] = Field(
1521        default=None, alias="AvailableLabels"
1522    )
1523    consumed_labels: Optional[List[LabelSummary]] = Field(
1524        default=None, alias="ConsumedLabels"
1525    )
1526
1527
1528class UpdateRuleGroupRequest(BaseModel):
1529    name: str = Field(alias="Name")
1530    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
1531    id: str = Field(alias="Id")
1532    visibility_config: VisibilityConfig = Field(alias="VisibilityConfig")
1533    lock_token: str = Field(alias="LockToken")
1534    description: Optional[str] = Field(default=None, alias="Description")
1535    rules: Optional[Sequence[Rule]] = Field(default=None, alias="Rules")
1536    custom_response_bodies: Optional[Mapping[str, CustomResponseBody]] = Field(
1537        default=None, alias="CustomResponseBodies"
1538    )
1539
1540
1541class UpdateWebACLRequest(BaseModel):
1542    name: str = Field(alias="Name")
1543    scope: Literal["CLOUDFRONT", "REGIONAL"] = Field(alias="Scope")
1544    id: str = Field(alias="Id")
1545    default_action: DefaultAction = Field(alias="DefaultAction")
1546    visibility_config: VisibilityConfig = Field(alias="VisibilityConfig")
1547    lock_token: str = Field(alias="LockToken")
1548    description: Optional[str] = Field(default=None, alias="Description")
1549    rules: Optional[Sequence[Rule]] = Field(default=None, alias="Rules")
1550    custom_response_bodies: Optional[Mapping[str, CustomResponseBody]] = Field(
1551        default=None, alias="CustomResponseBodies"
1552    )
1553    captcha_config: Optional[CaptchaConfig] = Field(default=None, alias="CaptchaConfig")
1554    challenge_config: Optional[ChallengeConfig] = Field(
1555        default=None, alias="ChallengeConfig"
1556    )
1557    token_domains: Optional[Sequence[str]] = Field(default=None, alias="TokenDomains")
1558
1559
1560class FirewallManagerStatement(BaseModel):
1561    managed_rule_group_statement: Optional[ManagedRuleGroupStatement] = Field(
1562        default=None, alias="ManagedRuleGroupStatement"
1563    )
1564    rule_group_reference_statement: Optional[RuleGroupReferenceStatement] = Field(
1565        default=None, alias="RuleGroupReferenceStatement"
1566    )
1567
1568
1569class Statement(BaseModel):
1570    byte_match_statement: Optional[ByteMatchStatement] = Field(
1571        default=None, alias="ByteMatchStatement"
1572    )
1573    sqli_match_statement: Optional[SqliMatchStatement] = Field(
1574        default=None, alias="SqliMatchStatement"
1575    )
1576    xss_match_statement: Optional[XssMatchStatement] = Field(
1577        default=None, alias="XssMatchStatement"
1578    )
1579    size_constraint_statement: Optional[SizeConstraintStatement] = Field(
1580        default=None, alias="SizeConstraintStatement"
1581    )
1582    geo_match_statement: Optional[GeoMatchStatement] = Field(
1583        default=None, alias="GeoMatchStatement"
1584    )
1585    rule_group_reference_statement: Optional[RuleGroupReferenceStatement] = Field(
1586        default=None, alias="RuleGroupReferenceStatement"
1587    )
1588    ip_set_reference_statement: Optional[IPSetReferenceStatement] = Field(
1589        default=None, alias="IPSetReferenceStatement"
1590    )
1591    regex_pattern_set_reference_statement: Optional[
1592        RegexPatternSetReferenceStatement
1593    ] = Field(default=None, alias="RegexPatternSetReferenceStatement")
1594    rate_based_statement: Optional[Dict[str, Any]] = Field(
1595        default=None, alias="RateBasedStatement"
1596    )
1597    and_statement: Optional[Dict[str, Any]] = Field(default=None, alias="AndStatement")
1598    or_statement: Optional[Dict[str, Any]] = Field(default=None, alias="OrStatement")
1599    not_statement: Optional[Dict[str, Any]] = Field(default=None, alias="NotStatement")
1600    managed_rule_group_statement: Optional[Dict[str, Any]] = Field(
1601        default=None, alias="ManagedRuleGroupStatement"
1602    )
1603    label_match_statement: Optional[LabelMatchStatement] = Field(
1604        default=None, alias="LabelMatchStatement"
1605    )
1606    regex_match_statement: Optional[RegexMatchStatement] = Field(
1607        default=None, alias="RegexMatchStatement"
1608    )
1609
1610
1611class GetRuleGroupResponse(BaseModel):
1612    rule_group: RuleGroup = Field(alias="RuleGroup")
1613    lock_token: str = Field(alias="LockToken")
1614    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1615
1616
1617class FirewallManagerRuleGroup(BaseModel):
1618    name: str = Field(alias="Name")
1619    priority: int = Field(alias="Priority")
1620    firewall_manager_statement: FirewallManagerStatement = Field(
1621        alias="FirewallManagerStatement"
1622    )
1623    override_action: OverrideAction = Field(alias="OverrideAction")
1624    visibility_config: VisibilityConfig = Field(alias="VisibilityConfig")
1625
1626
1627class WebACL(BaseModel):
1628    name: str = Field(alias="Name")
1629    id: str = Field(alias="Id")
1630    arn: str = Field(alias="ARN")
1631    default_action: DefaultAction = Field(alias="DefaultAction")
1632    visibility_config: VisibilityConfig = Field(alias="VisibilityConfig")
1633    description: Optional[str] = Field(default=None, alias="Description")
1634    rules: Optional[List[Rule]] = Field(default=None, alias="Rules")
1635    capacity: Optional[int] = Field(default=None, alias="Capacity")
1636    pre_process_firewall_manager_rule_groups: Optional[
1637        List[FirewallManagerRuleGroup]
1638    ] = Field(default=None, alias="PreProcessFirewallManagerRuleGroups")
1639    post_process_firewall_manager_rule_groups: Optional[
1640        List[FirewallManagerRuleGroup]
1641    ] = Field(default=None, alias="PostProcessFirewallManagerRuleGroups")
1642    managed_by_firewall_manager: Optional[bool] = Field(
1643        default=None, alias="ManagedByFirewallManager"
1644    )
1645    label_namespace: Optional[str] = Field(default=None, alias="LabelNamespace")
1646    custom_response_bodies: Optional[Dict[str, CustomResponseBody]] = Field(
1647        default=None, alias="CustomResponseBodies"
1648    )
1649    captcha_config: Optional[CaptchaConfig] = Field(default=None, alias="CaptchaConfig")
1650    challenge_config: Optional[ChallengeConfig] = Field(
1651        default=None, alias="ChallengeConfig"
1652    )
1653    token_domains: Optional[List[str]] = Field(default=None, alias="TokenDomains")
1654
1655
1656class GetWebACLForResourceResponse(BaseModel):
1657    web_acl: WebACL = Field(alias="WebACL")
1658    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")
1659
1660
1661class GetWebACLResponse(BaseModel):
1662    web_acl: WebACL = Field(alias="WebACL")
1663    lock_token: str = Field(alias="LockToken")
1664    application_integration_url: str = Field(alias="ApplicationIntegrationURL")
1665    response_metadata: ResponseMetadata = Field(alias="ResponseMetadata")