WAFV2Client

Index > WAFV2 > WAFV2Client

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

WAFV2Client

Type annotations and code completion for boto3.client("wafv2"). boto3 documentation

# WAFV2Client usage example

from boto3.session import Session
from mypy_boto3_wafv2.client import WAFV2Client

def get_wafv2_client() -> WAFV2Client:
    return Session().client("wafv2")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("wafv2").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("wafv2")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.WAFAssociatedItemException,
    client.exceptions.WAFConfigurationWarningException,
    client.exceptions.WAFDuplicateItemException,
    client.exceptions.WAFExpiredManagedRuleGroupVersionException,
    client.exceptions.WAFInternalErrorException,
    client.exceptions.WAFInvalidOperationException,
    client.exceptions.WAFInvalidParameterException,
    client.exceptions.WAFInvalidPermissionPolicyException,
    client.exceptions.WAFInvalidResourceException,
    client.exceptions.WAFLimitsExceededException,
    client.exceptions.WAFLogDestinationPermissionIssueException,
    client.exceptions.WAFNonexistentItemException,
    client.exceptions.WAFOptimisticLockException,
    client.exceptions.WAFServiceLinkedRoleErrorException,
    client.exceptions.WAFSubscriptionNotFoundException,
    client.exceptions.WAFTagOperationException,
    client.exceptions.WAFTagOperationInternalErrorException,
    client.exceptions.WAFUnavailableEntityException,
    client.exceptions.WAFUnsupportedAggregateKeyTypeException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_wafv2.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

associate_web_acl

Associates a web ACL with a regional application resource, to protect the resource.

Type annotations and code completion for boto3.client("wafv2").associate_web_acl method. boto3 documentation

# associate_web_acl method definition

def associate_web_acl(
    self,
    *,
    WebACLArn: str,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...

# associate_web_acl method usage example with argument unpacking

kwargs: AssociateWebACLRequestRequestTypeDef = {  # (1)
    "WebACLArn": ...,
    "ResourceArn": ...,
}

parent.associate_web_acl(**kwargs)

1. See AssociateWebACLRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("wafv2").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

check_capacity

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules.

Type annotations and code completion for boto3.client("wafv2").check_capacity method. boto3 documentation

# check_capacity method definition

def check_capacity(
    self,
    *,
    Scope: ScopeType,  # (1)
    Rules: Sequence[RuleTypeDef],  # (2)
) -> CheckCapacityResponseTypeDef:  # (3)
    ...

1. See ScopeType
2. See RuleTypeDef
3. See CheckCapacityResponseTypeDef

# check_capacity method usage example with argument unpacking

kwargs: CheckCapacityRequestRequestTypeDef = {  # (1)
    "Scope": ...,
    "Rules": ...,
}

parent.check_capacity(**kwargs)

1. See CheckCapacityRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("wafv2").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_api_key

Creates an API key that contains a set of token domains.

Type annotations and code completion for boto3.client("wafv2").create_api_key method. boto3 documentation

# create_api_key method definition

def create_api_key(
    self,
    *,
    Scope: ScopeType,  # (1)
    TokenDomains: Sequence[str],
) -> CreateAPIKeyResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See CreateAPIKeyResponseTypeDef

# create_api_key method usage example with argument unpacking

kwargs: CreateAPIKeyRequestRequestTypeDef = {  # (1)
    "Scope": ...,
    "TokenDomains": ...,
}

parent.create_api_key(**kwargs)

1. See CreateAPIKeyRequestRequestTypeDef

create_ip_set

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses.

Type annotations and code completion for boto3.client("wafv2").create_ip_set method. boto3 documentation

# create_ip_set method definition

def create_ip_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    IPAddressVersion: IPAddressVersionType,  # (2)
    Addresses: Sequence[str],
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateIPSetResponseTypeDef:  # (4)
    ...

1. See ScopeType
2. See IPAddressVersionType
3. See TagTypeDef
4. See CreateIPSetResponseTypeDef

# create_ip_set method usage example with argument unpacking

kwargs: CreateIPSetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "IPAddressVersion": ...,
    "Addresses": ...,
}

parent.create_ip_set(**kwargs)

1. See CreateIPSetRequestRequestTypeDef

create_regex_pattern_set

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.

Type annotations and code completion for boto3.client("wafv2").create_regex_pattern_set method. boto3 documentation

# create_regex_pattern_set method definition

def create_regex_pattern_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    RegularExpressionList: Sequence[RegexTypeDef],  # (2)
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateRegexPatternSetResponseTypeDef:  # (4)
    ...

1. See ScopeType
2. See RegexTypeDef
3. See TagTypeDef
4. See CreateRegexPatternSetResponseTypeDef

# create_regex_pattern_set method usage example with argument unpacking

kwargs: CreateRegexPatternSetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "RegularExpressionList": ...,
}

parent.create_regex_pattern_set(**kwargs)

1. See CreateRegexPatternSetRequestRequestTypeDef

create_rule_group

Creates a RuleGroup per the specifications provided.

Type annotations and code completion for boto3.client("wafv2").create_rule_group method. boto3 documentation

# create_rule_group method definition

def create_rule_group(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Capacity: int,
    VisibilityConfig: VisibilityConfigTypeDef,  # (2)
    Description: str = ...,
    Rules: Sequence[RuleTypeDef] = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    CustomResponseBodies: Mapping[str, CustomResponseBodyTypeDef] = ...,  # (5)
) -> CreateRuleGroupResponseTypeDef:  # (6)
    ...

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

# create_rule_group method usage example with argument unpacking

kwargs: CreateRuleGroupRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Capacity": ...,
    "VisibilityConfig": ...,
}

parent.create_rule_group(**kwargs)

1. See CreateRuleGroupRequestRequestTypeDef

create_web_acl

Creates a WebACL per the specifications provided.

Type annotations and code completion for boto3.client("wafv2").create_web_acl method. boto3 documentation

# create_web_acl method definition

def create_web_acl(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    DefaultAction: DefaultActionTypeDef,  # (2)
    VisibilityConfig: VisibilityConfigTypeDef,  # (3)
    Description: str = ...,
    Rules: Sequence[RuleTypeDef] = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
    CustomResponseBodies: Mapping[str, CustomResponseBodyTypeDef] = ...,  # (6)
    CaptchaConfig: CaptchaConfigTypeDef = ...,  # (7)
    ChallengeConfig: ChallengeConfigTypeDef = ...,  # (8)
    TokenDomains: Sequence[str] = ...,
    AssociationConfig: AssociationConfigTypeDef = ...,  # (9)
) -> CreateWebACLResponseTypeDef:  # (10)
    ...

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
10. See CreateWebACLResponseTypeDef

# create_web_acl method usage example with argument unpacking

kwargs: CreateWebACLRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "DefaultAction": ...,
    "VisibilityConfig": ...,
}

parent.create_web_acl(**kwargs)

1. See CreateWebACLRequestRequestTypeDef

delete_firewall_manager_rule_groups

Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

Type annotations and code completion for boto3.client("wafv2").delete_firewall_manager_rule_groups method. boto3 documentation

# delete_firewall_manager_rule_groups method definition

def delete_firewall_manager_rule_groups(
    self,
    *,
    WebACLArn: str,
    WebACLLockToken: str,
) -> DeleteFirewallManagerRuleGroupsResponseTypeDef:  # (1)
    ...

1. See DeleteFirewallManagerRuleGroupsResponseTypeDef

# delete_firewall_manager_rule_groups method usage example with argument unpacking

kwargs: DeleteFirewallManagerRuleGroupsRequestRequestTypeDef = {  # (1)
    "WebACLArn": ...,
    "WebACLLockToken": ...,
}

parent.delete_firewall_manager_rule_groups(**kwargs)

1. See DeleteFirewallManagerRuleGroupsRequestRequestTypeDef

delete_ip_set

Deletes the specified IPSet.

Type annotations and code completion for boto3.client("wafv2").delete_ip_set method. boto3 documentation

# delete_ip_set method definition

def delete_ip_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
) -> Dict[str, Any]:
    ...

1. See ScopeType

# delete_ip_set method usage example with argument unpacking

kwargs: DeleteIPSetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
    "LockToken": ...,
}

parent.delete_ip_set(**kwargs)

1. See DeleteIPSetRequestRequestTypeDef

delete_logging_configuration

Deletes the LoggingConfiguration from the specified web ACL.

Type annotations and code completion for boto3.client("wafv2").delete_logging_configuration method. boto3 documentation

# delete_logging_configuration method definition

def delete_logging_configuration(
    self,
    *,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...

# delete_logging_configuration method usage example with argument unpacking

kwargs: DeleteLoggingConfigurationRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_logging_configuration(**kwargs)

1. See DeleteLoggingConfigurationRequestRequestTypeDef

delete_permission_policy

Permanently deletes an IAM policy from the specified rule group.

Type annotations and code completion for boto3.client("wafv2").delete_permission_policy method. boto3 documentation

# delete_permission_policy method definition

def delete_permission_policy(
    self,
    *,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...

# delete_permission_policy method usage example with argument unpacking

kwargs: DeletePermissionPolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_permission_policy(**kwargs)

1. See DeletePermissionPolicyRequestRequestTypeDef

delete_regex_pattern_set

Deletes the specified RegexPatternSet.

Type annotations and code completion for boto3.client("wafv2").delete_regex_pattern_set method. boto3 documentation

# delete_regex_pattern_set method definition

def delete_regex_pattern_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
) -> Dict[str, Any]:
    ...

1. See ScopeType

# delete_regex_pattern_set method usage example with argument unpacking

kwargs: DeleteRegexPatternSetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
    "LockToken": ...,
}

parent.delete_regex_pattern_set(**kwargs)

1. See DeleteRegexPatternSetRequestRequestTypeDef

delete_rule_group

Deletes the specified RuleGroup.

Type annotations and code completion for boto3.client("wafv2").delete_rule_group method. boto3 documentation

# delete_rule_group method definition

def delete_rule_group(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
) -> Dict[str, Any]:
    ...

1. See ScopeType

# delete_rule_group method usage example with argument unpacking

kwargs: DeleteRuleGroupRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
    "LockToken": ...,
}

parent.delete_rule_group(**kwargs)

1. See DeleteRuleGroupRequestRequestTypeDef

delete_web_acl

Deletes the specified WebACL.

Type annotations and code completion for boto3.client("wafv2").delete_web_acl method. boto3 documentation

# delete_web_acl method definition

def delete_web_acl(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
) -> Dict[str, Any]:
    ...

1. See ScopeType

# delete_web_acl method usage example with argument unpacking

kwargs: DeleteWebACLRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
    "LockToken": ...,
}

parent.delete_web_acl(**kwargs)

1. See DeleteWebACLRequestRequestTypeDef

describe_all_managed_products

Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

Type annotations and code completion for boto3.client("wafv2").describe_all_managed_products method. boto3 documentation

# describe_all_managed_products method definition

def describe_all_managed_products(
    self,
    *,
    Scope: ScopeType,  # (1)
) -> DescribeAllManagedProductsResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See DescribeAllManagedProductsResponseTypeDef

# describe_all_managed_products method usage example with argument unpacking

kwargs: DescribeAllManagedProductsRequestRequestTypeDef = {  # (1)
    "Scope": ...,
}

parent.describe_all_managed_products(**kwargs)

1. See DescribeAllManagedProductsRequestRequestTypeDef

describe_managed_products_by_vendor

Provides high-level information for the managed rule groups owned by a specific vendor.

Type annotations and code completion for boto3.client("wafv2").describe_managed_products_by_vendor method. boto3 documentation

# describe_managed_products_by_vendor method definition

def describe_managed_products_by_vendor(
    self,
    *,
    VendorName: str,
    Scope: ScopeType,  # (1)
) -> DescribeManagedProductsByVendorResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See DescribeManagedProductsByVendorResponseTypeDef

# describe_managed_products_by_vendor method usage example with argument unpacking

kwargs: DescribeManagedProductsByVendorRequestRequestTypeDef = {  # (1)
    "VendorName": ...,
    "Scope": ...,
}

parent.describe_managed_products_by_vendor(**kwargs)

1. See DescribeManagedProductsByVendorRequestRequestTypeDef

describe_managed_rule_group

Provides high-level information for a managed rule group, including descriptions of the rules.

Type annotations and code completion for boto3.client("wafv2").describe_managed_rule_group method. boto3 documentation

# describe_managed_rule_group method definition

def describe_managed_rule_group(
    self,
    *,
    VendorName: str,
    Name: str,
    Scope: ScopeType,  # (1)
    VersionName: str = ...,
) -> DescribeManagedRuleGroupResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See DescribeManagedRuleGroupResponseTypeDef

# describe_managed_rule_group method usage example with argument unpacking

kwargs: DescribeManagedRuleGroupRequestRequestTypeDef = {  # (1)
    "VendorName": ...,
    "Name": ...,
    "Scope": ...,
}

parent.describe_managed_rule_group(**kwargs)

1. See DescribeManagedRuleGroupRequestRequestTypeDef

disassociate_web_acl

Disassociates the specified regional application resource from any existing web ACL association.

Type annotations and code completion for boto3.client("wafv2").disassociate_web_acl method. boto3 documentation

# disassociate_web_acl method definition

def disassociate_web_acl(
    self,
    *,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...

# disassociate_web_acl method usage example with argument unpacking

kwargs: DisassociateWebACLRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.disassociate_web_acl(**kwargs)

1. See DisassociateWebACLRequestRequestTypeDef

generate_mobile_sdk_release_url

Generates a presigned download URL for the specified release of the mobile SDK.

Type annotations and code completion for boto3.client("wafv2").generate_mobile_sdk_release_url method. boto3 documentation

# generate_mobile_sdk_release_url method definition

def generate_mobile_sdk_release_url(
    self,
    *,
    Platform: PlatformType,  # (1)
    ReleaseVersion: str,
) -> GenerateMobileSdkReleaseUrlResponseTypeDef:  # (2)
    ...

1. See PlatformType
2. See GenerateMobileSdkReleaseUrlResponseTypeDef

# generate_mobile_sdk_release_url method usage example with argument unpacking

kwargs: GenerateMobileSdkReleaseUrlRequestRequestTypeDef = {  # (1)
    "Platform": ...,
    "ReleaseVersion": ...,
}

parent.generate_mobile_sdk_release_url(**kwargs)

1. See GenerateMobileSdkReleaseUrlRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("wafv2").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_decrypted_api_key

Returns your API key in decrypted form.

Type annotations and code completion for boto3.client("wafv2").get_decrypted_api_key method. boto3 documentation

# get_decrypted_api_key method definition

def get_decrypted_api_key(
    self,
    *,
    Scope: ScopeType,  # (1)
    APIKey: str,
) -> GetDecryptedAPIKeyResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See GetDecryptedAPIKeyResponseTypeDef

# get_decrypted_api_key method usage example with argument unpacking

kwargs: GetDecryptedAPIKeyRequestRequestTypeDef = {  # (1)
    "Scope": ...,
    "APIKey": ...,
}

parent.get_decrypted_api_key(**kwargs)

1. See GetDecryptedAPIKeyRequestRequestTypeDef

get_ip_set

Retrieves the specified IPSet.

Type annotations and code completion for boto3.client("wafv2").get_ip_set method. boto3 documentation

# get_ip_set method definition

def get_ip_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
) -> GetIPSetResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See GetIPSetResponseTypeDef

# get_ip_set method usage example with argument unpacking

kwargs: GetIPSetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
}

parent.get_ip_set(**kwargs)

1. See GetIPSetRequestRequestTypeDef

get_logging_configuration

Returns the LoggingConfiguration for the specified web ACL.

Type annotations and code completion for boto3.client("wafv2").get_logging_configuration method. boto3 documentation

# get_logging_configuration method definition

def get_logging_configuration(
    self,
    *,
    ResourceArn: str,
) -> GetLoggingConfigurationResponseTypeDef:  # (1)
    ...

1. See GetLoggingConfigurationResponseTypeDef

# get_logging_configuration method usage example with argument unpacking

kwargs: GetLoggingConfigurationRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_logging_configuration(**kwargs)

1. See GetLoggingConfigurationRequestRequestTypeDef

get_managed_rule_set

Retrieves the specified managed rule set.

Type annotations and code completion for boto3.client("wafv2").get_managed_rule_set method. boto3 documentation

# get_managed_rule_set method definition

def get_managed_rule_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
) -> GetManagedRuleSetResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See GetManagedRuleSetResponseTypeDef

# get_managed_rule_set method usage example with argument unpacking

kwargs: GetManagedRuleSetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
}

parent.get_managed_rule_set(**kwargs)

1. See GetManagedRuleSetRequestRequestTypeDef

get_mobile_sdk_release

Retrieves information for the specified mobile SDK release, including release notes and tags.

Type annotations and code completion for boto3.client("wafv2").get_mobile_sdk_release method. boto3 documentation

# get_mobile_sdk_release method definition

def get_mobile_sdk_release(
    self,
    *,
    Platform: PlatformType,  # (1)
    ReleaseVersion: str,
) -> GetMobileSdkReleaseResponseTypeDef:  # (2)
    ...

1. See PlatformType
2. See GetMobileSdkReleaseResponseTypeDef

# get_mobile_sdk_release method usage example with argument unpacking

kwargs: GetMobileSdkReleaseRequestRequestTypeDef = {  # (1)
    "Platform": ...,
    "ReleaseVersion": ...,
}

parent.get_mobile_sdk_release(**kwargs)

1. See GetMobileSdkReleaseRequestRequestTypeDef

get_permission_policy

Returns the IAM policy that is attached to the specified rule group.

Type annotations and code completion for boto3.client("wafv2").get_permission_policy method. boto3 documentation

# get_permission_policy method definition

def get_permission_policy(
    self,
    *,
    ResourceArn: str,
) -> GetPermissionPolicyResponseTypeDef:  # (1)
    ...

1. See GetPermissionPolicyResponseTypeDef

# get_permission_policy method usage example with argument unpacking

kwargs: GetPermissionPolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_permission_policy(**kwargs)

1. See GetPermissionPolicyRequestRequestTypeDef

get_rate_based_statement_managed_keys

Retrieves the IP addresses that are currently blocked by a rate-based rule instance.

Type annotations and code completion for boto3.client("wafv2").get_rate_based_statement_managed_keys method. boto3 documentation

# get_rate_based_statement_managed_keys method definition

def get_rate_based_statement_managed_keys(
    self,
    *,
    Scope: ScopeType,  # (1)
    WebACLName: str,
    WebACLId: str,
    RuleName: str,
    RuleGroupRuleName: str = ...,
) -> GetRateBasedStatementManagedKeysResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See GetRateBasedStatementManagedKeysResponseTypeDef

# get_rate_based_statement_managed_keys method usage example with argument unpacking

kwargs: GetRateBasedStatementManagedKeysRequestRequestTypeDef = {  # (1)
    "Scope": ...,
    "WebACLName": ...,
    "WebACLId": ...,
    "RuleName": ...,
}

parent.get_rate_based_statement_managed_keys(**kwargs)

1. See GetRateBasedStatementManagedKeysRequestRequestTypeDef

get_regex_pattern_set

Retrieves the specified RegexPatternSet.

Type annotations and code completion for boto3.client("wafv2").get_regex_pattern_set method. boto3 documentation

# get_regex_pattern_set method definition

def get_regex_pattern_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
) -> GetRegexPatternSetResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See GetRegexPatternSetResponseTypeDef

# get_regex_pattern_set method usage example with argument unpacking

kwargs: GetRegexPatternSetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
}

parent.get_regex_pattern_set(**kwargs)

1. See GetRegexPatternSetRequestRequestTypeDef

get_rule_group

Retrieves the specified RuleGroup.

Type annotations and code completion for boto3.client("wafv2").get_rule_group method. boto3 documentation

# get_rule_group method definition

def get_rule_group(
    self,
    *,
    Name: str = ...,
    Scope: ScopeType = ...,  # (1)
    Id: str = ...,
    ARN: str = ...,
) -> GetRuleGroupResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See GetRuleGroupResponseTypeDef

# get_rule_group method usage example with argument unpacking

kwargs: GetRuleGroupRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_rule_group(**kwargs)

1. See GetRuleGroupRequestRequestTypeDef

get_sampled_requests

Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose.

Type annotations and code completion for boto3.client("wafv2").get_sampled_requests method. boto3 documentation

# get_sampled_requests method definition

def get_sampled_requests(
    self,
    *,
    WebAclArn: str,
    RuleMetricName: str,
    Scope: ScopeType,  # (1)
    TimeWindow: TimeWindowTypeDef,  # (2)
    MaxItems: int,
) -> GetSampledRequestsResponseTypeDef:  # (3)
    ...

1. See ScopeType
2. See TimeWindowTypeDef
3. See GetSampledRequestsResponseTypeDef

# get_sampled_requests method usage example with argument unpacking

kwargs: GetSampledRequestsRequestRequestTypeDef = {  # (1)
    "WebAclArn": ...,
    "RuleMetricName": ...,
    "Scope": ...,
    "TimeWindow": ...,
    "MaxItems": ...,
}

parent.get_sampled_requests(**kwargs)

1. See GetSampledRequestsRequestRequestTypeDef

get_web_acl

Retrieves the specified WebACL.

Type annotations and code completion for boto3.client("wafv2").get_web_acl method. boto3 documentation

# get_web_acl method definition

def get_web_acl(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
) -> GetWebACLResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See GetWebACLResponseTypeDef

# get_web_acl method usage example with argument unpacking

kwargs: GetWebACLRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
}

parent.get_web_acl(**kwargs)

1. See GetWebACLRequestRequestTypeDef

get_web_acl_for_resource

Retrieves the WebACL for the specified resource.

Type annotations and code completion for boto3.client("wafv2").get_web_acl_for_resource method. boto3 documentation

# get_web_acl_for_resource method definition

def get_web_acl_for_resource(
    self,
    *,
    ResourceArn: str,
) -> GetWebACLForResourceResponseTypeDef:  # (1)
    ...

1. See GetWebACLForResourceResponseTypeDef

# get_web_acl_for_resource method usage example with argument unpacking

kwargs: GetWebACLForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_web_acl_for_resource(**kwargs)

1. See GetWebACLForResourceRequestRequestTypeDef

list_api_keys

Retrieves a list of the API keys that you've defined for the specified scope.

Type annotations and code completion for boto3.client("wafv2").list_api_keys method. boto3 documentation

# list_api_keys method definition

def list_api_keys(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListAPIKeysResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See ListAPIKeysResponseTypeDef

# list_api_keys method usage example with argument unpacking

kwargs: ListAPIKeysRequestRequestTypeDef = {  # (1)
    "Scope": ...,
}

parent.list_api_keys(**kwargs)

1. See ListAPIKeysRequestRequestTypeDef

list_available_managed_rule_group_versions

Returns a list of the available versions for the specified managed rule group.

Type annotations and code completion for boto3.client("wafv2").list_available_managed_rule_group_versions method. boto3 documentation

# list_available_managed_rule_group_versions method definition

def list_available_managed_rule_group_versions(
    self,
    *,
    VendorName: str,
    Name: str,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListAvailableManagedRuleGroupVersionsResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See ListAvailableManagedRuleGroupVersionsResponseTypeDef

# list_available_managed_rule_group_versions method usage example with argument unpacking

kwargs: ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef = {  # (1)
    "VendorName": ...,
    "Name": ...,
    "Scope": ...,
}

parent.list_available_managed_rule_group_versions(**kwargs)

1. See ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef

list_available_managed_rule_groups

Retrieves an array of managed rule groups that are available for you to use.

Type annotations and code completion for boto3.client("wafv2").list_available_managed_rule_groups method. boto3 documentation

# list_available_managed_rule_groups method definition

def list_available_managed_rule_groups(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListAvailableManagedRuleGroupsResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See ListAvailableManagedRuleGroupsResponseTypeDef

# list_available_managed_rule_groups method usage example with argument unpacking

kwargs: ListAvailableManagedRuleGroupsRequestRequestTypeDef = {  # (1)
    "Scope": ...,
}

parent.list_available_managed_rule_groups(**kwargs)

1. See ListAvailableManagedRuleGroupsRequestRequestTypeDef

list_ip_sets

Retrieves an array of IPSetSummary objects for the IP sets that you manage.

Type annotations and code completion for boto3.client("wafv2").list_ip_sets method. boto3 documentation

# list_ip_sets method definition

def list_ip_sets(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListIPSetsResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See ListIPSetsResponseTypeDef

# list_ip_sets method usage example with argument unpacking

kwargs: ListIPSetsRequestRequestTypeDef = {  # (1)
    "Scope": ...,
}

parent.list_ip_sets(**kwargs)

1. See ListIPSetsRequestRequestTypeDef

list_logging_configurations

Retrieves an array of your LoggingConfiguration objects.

Type annotations and code completion for boto3.client("wafv2").list_logging_configurations method. boto3 documentation

# list_logging_configurations method definition

def list_logging_configurations(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListLoggingConfigurationsResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See ListLoggingConfigurationsResponseTypeDef

# list_logging_configurations method usage example with argument unpacking

kwargs: ListLoggingConfigurationsRequestRequestTypeDef = {  # (1)
    "Scope": ...,
}

parent.list_logging_configurations(**kwargs)

1. See ListLoggingConfigurationsRequestRequestTypeDef

list_managed_rule_sets

Retrieves the managed rule sets that you own.

Type annotations and code completion for boto3.client("wafv2").list_managed_rule_sets method. boto3 documentation

# list_managed_rule_sets method definition

def list_managed_rule_sets(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListManagedRuleSetsResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See ListManagedRuleSetsResponseTypeDef

# list_managed_rule_sets method usage example with argument unpacking

kwargs: ListManagedRuleSetsRequestRequestTypeDef = {  # (1)
    "Scope": ...,
}

parent.list_managed_rule_sets(**kwargs)

1. See ListManagedRuleSetsRequestRequestTypeDef

list_mobile_sdk_releases

Retrieves a list of the available releases for the mobile SDK and the specified device platform.

Type annotations and code completion for boto3.client("wafv2").list_mobile_sdk_releases method. boto3 documentation

# list_mobile_sdk_releases method definition

def list_mobile_sdk_releases(
    self,
    *,
    Platform: PlatformType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListMobileSdkReleasesResponseTypeDef:  # (2)
    ...

1. See PlatformType
2. See ListMobileSdkReleasesResponseTypeDef

# list_mobile_sdk_releases method usage example with argument unpacking

kwargs: ListMobileSdkReleasesRequestRequestTypeDef = {  # (1)
    "Platform": ...,
}

parent.list_mobile_sdk_releases(**kwargs)

1. See ListMobileSdkReleasesRequestRequestTypeDef

list_regex_pattern_sets

Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.

Type annotations and code completion for boto3.client("wafv2").list_regex_pattern_sets method. boto3 documentation

# list_regex_pattern_sets method definition

def list_regex_pattern_sets(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListRegexPatternSetsResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See ListRegexPatternSetsResponseTypeDef

# list_regex_pattern_sets method usage example with argument unpacking

kwargs: ListRegexPatternSetsRequestRequestTypeDef = {  # (1)
    "Scope": ...,
}

parent.list_regex_pattern_sets(**kwargs)

1. See ListRegexPatternSetsRequestRequestTypeDef

list_resources_for_web_acl

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.

Type annotations and code completion for boto3.client("wafv2").list_resources_for_web_acl method. boto3 documentation

# list_resources_for_web_acl method definition

def list_resources_for_web_acl(
    self,
    *,
    WebACLArn: str,
    ResourceType: ResourceTypeType = ...,  # (1)
) -> ListResourcesForWebACLResponseTypeDef:  # (2)
    ...

1. See ResourceTypeType
2. See ListResourcesForWebACLResponseTypeDef

# list_resources_for_web_acl method usage example with argument unpacking

kwargs: ListResourcesForWebACLRequestRequestTypeDef = {  # (1)
    "WebACLArn": ...,
}

parent.list_resources_for_web_acl(**kwargs)

1. See ListResourcesForWebACLRequestRequestTypeDef

list_rule_groups

Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.

Type annotations and code completion for boto3.client("wafv2").list_rule_groups method. boto3 documentation

# list_rule_groups method definition

def list_rule_groups(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListRuleGroupsResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See ListRuleGroupsResponseTypeDef

# list_rule_groups method usage example with argument unpacking

kwargs: ListRuleGroupsRequestRequestTypeDef = {  # (1)
    "Scope": ...,
}

parent.list_rule_groups(**kwargs)

1. See ListRuleGroupsRequestRequestTypeDef

list_tags_for_resource

Retrieves the TagInfoForResource for the specified resource.

Type annotations and code completion for boto3.client("wafv2").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_web_acls

Retrieves an array of WebACLSummary objects for the web ACLs that you manage.

Type annotations and code completion for boto3.client("wafv2").list_web_acls method. boto3 documentation

# list_web_acls method definition

def list_web_acls(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListWebACLsResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See ListWebACLsResponseTypeDef

# list_web_acls method usage example with argument unpacking

kwargs: ListWebACLsRequestRequestTypeDef = {  # (1)
    "Scope": ...,
}

parent.list_web_acls(**kwargs)

1. See ListWebACLsRequestRequestTypeDef

put_logging_configuration

Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

Type annotations and code completion for boto3.client("wafv2").put_logging_configuration method. boto3 documentation

# put_logging_configuration method definition

def put_logging_configuration(
    self,
    *,
    LoggingConfiguration: LoggingConfigurationTypeDef,  # (1)
) -> PutLoggingConfigurationResponseTypeDef:  # (2)
    ...

1. See LoggingConfigurationTypeDef
2. See PutLoggingConfigurationResponseTypeDef

# put_logging_configuration method usage example with argument unpacking

kwargs: PutLoggingConfigurationRequestRequestTypeDef = {  # (1)
    "LoggingConfiguration": ...,
}

parent.put_logging_configuration(**kwargs)

1. See PutLoggingConfigurationRequestRequestTypeDef

put_managed_rule_set_versions

Defines the versions of your managed rule set that you are offering to the customers.

Type annotations and code completion for boto3.client("wafv2").put_managed_rule_set_versions method. boto3 documentation

# put_managed_rule_set_versions method definition

def put_managed_rule_set_versions(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
    RecommendedVersion: str = ...,
    VersionsToPublish: Mapping[str, VersionToPublishTypeDef] = ...,  # (2)
) -> PutManagedRuleSetVersionsResponseTypeDef:  # (3)
    ...

1. See ScopeType
2. See VersionToPublishTypeDef
3. See PutManagedRuleSetVersionsResponseTypeDef

# put_managed_rule_set_versions method usage example with argument unpacking

kwargs: PutManagedRuleSetVersionsRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
    "LockToken": ...,
}

parent.put_managed_rule_set_versions(**kwargs)

1. See PutManagedRuleSetVersionsRequestRequestTypeDef

put_permission_policy

Attaches an IAM policy to the specified resource.

Type annotations and code completion for boto3.client("wafv2").put_permission_policy method. boto3 documentation

# put_permission_policy method definition

def put_permission_policy(
    self,
    *,
    ResourceArn: str,
    Policy: str,
) -> Dict[str, Any]:
    ...

# put_permission_policy method usage example with argument unpacking

kwargs: PutPermissionPolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Policy": ...,
}

parent.put_permission_policy(**kwargs)

1. See PutPermissionPolicyRequestRequestTypeDef

tag_resource

Associates tags with the specified Amazon Web Services resource.

Type annotations and code completion for boto3.client("wafv2").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Disassociates tags from an Amazon Web Services resource.

Type annotations and code completion for boto3.client("wafv2").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_ip_set

Updates the specified IPSet.

Type annotations and code completion for boto3.client("wafv2").update_ip_set method. boto3 documentation

# update_ip_set method definition

def update_ip_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    Addresses: Sequence[str],
    LockToken: str,
    Description: str = ...,
) -> UpdateIPSetResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See UpdateIPSetResponseTypeDef

# update_ip_set method usage example with argument unpacking

kwargs: UpdateIPSetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
    "Addresses": ...,
    "LockToken": ...,
}

parent.update_ip_set(**kwargs)

1. See UpdateIPSetRequestRequestTypeDef

update_managed_rule_set_version_expiry_date

Updates the expiration information for your managed rule set.

Type annotations and code completion for boto3.client("wafv2").update_managed_rule_set_version_expiry_date method. boto3 documentation

# update_managed_rule_set_version_expiry_date method definition

def update_managed_rule_set_version_expiry_date(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
    VersionToExpire: str,
    ExpiryTimestamp: Union[datetime, str],
) -> UpdateManagedRuleSetVersionExpiryDateResponseTypeDef:  # (2)
    ...

1. See ScopeType
2. See UpdateManagedRuleSetVersionExpiryDateResponseTypeDef

# update_managed_rule_set_version_expiry_date method usage example with argument unpacking

kwargs: UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
    "LockToken": ...,
    "VersionToExpire": ...,
    "ExpiryTimestamp": ...,
}

parent.update_managed_rule_set_version_expiry_date(**kwargs)

1. See UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef

update_regex_pattern_set

Updates the specified RegexPatternSet.

Type annotations and code completion for boto3.client("wafv2").update_regex_pattern_set method. boto3 documentation

# update_regex_pattern_set method definition

def update_regex_pattern_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    RegularExpressionList: Sequence[RegexTypeDef],  # (2)
    LockToken: str,
    Description: str = ...,
) -> UpdateRegexPatternSetResponseTypeDef:  # (3)
    ...

1. See ScopeType
2. See RegexTypeDef
3. See UpdateRegexPatternSetResponseTypeDef

# update_regex_pattern_set method usage example with argument unpacking

kwargs: UpdateRegexPatternSetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
    "RegularExpressionList": ...,
    "LockToken": ...,
}

parent.update_regex_pattern_set(**kwargs)

1. See UpdateRegexPatternSetRequestRequestTypeDef

update_rule_group

Updates the specified RuleGroup.

Type annotations and code completion for boto3.client("wafv2").update_rule_group method. boto3 documentation

# update_rule_group method definition

def update_rule_group(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    VisibilityConfig: VisibilityConfigTypeDef,  # (2)
    LockToken: str,
    Description: str = ...,
    Rules: Sequence[RuleTypeDef] = ...,  # (3)
    CustomResponseBodies: Mapping[str, CustomResponseBodyTypeDef] = ...,  # (4)
) -> UpdateRuleGroupResponseTypeDef:  # (5)
    ...

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

# update_rule_group method usage example with argument unpacking

kwargs: UpdateRuleGroupRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
    "VisibilityConfig": ...,
    "LockToken": ...,
}

parent.update_rule_group(**kwargs)

1. See UpdateRuleGroupRequestRequestTypeDef

update_web_acl

Updates the specified WebACL.

Type annotations and code completion for boto3.client("wafv2").update_web_acl method. boto3 documentation

# update_web_acl method definition

def update_web_acl(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    DefaultAction: DefaultActionTypeDef,  # (2)
    VisibilityConfig: VisibilityConfigTypeDef,  # (3)
    LockToken: str,
    Description: str = ...,
    Rules: Sequence[RuleTypeDef] = ...,  # (4)
    CustomResponseBodies: Mapping[str, CustomResponseBodyTypeDef] = ...,  # (5)
    CaptchaConfig: CaptchaConfigTypeDef = ...,  # (6)
    ChallengeConfig: ChallengeConfigTypeDef = ...,  # (7)
    TokenDomains: Sequence[str] = ...,
    AssociationConfig: AssociationConfigTypeDef = ...,  # (8)
) -> UpdateWebACLResponseTypeDef:  # (9)
    ...

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

# update_web_acl method usage example with argument unpacking

kwargs: UpdateWebACLRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
    "DefaultAction": ...,
    "VisibilityConfig": ...,
    "LockToken": ...,
}

parent.update_web_acl(**kwargs)

1. See UpdateWebACLRequestRequestTypeDef