Skip to content

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

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.

Usage example
client = boto3.client("wafv2")

try:
    do_something(client)
except (
    client.ClientError,
    client.WAFAssociatedItemException,
    client.WAFConfigurationWarningException,
    client.WAFDuplicateItemException,
    client.WAFExpiredManagedRuleGroupVersionException,
    client.WAFInternalErrorException,
    client.WAFInvalidOperationException,
    client.WAFInvalidParameterException,
    client.WAFInvalidPermissionPolicyException,
    client.WAFInvalidResourceException,
    client.WAFLimitsExceededException,
    client.WAFLogDestinationPermissionIssueException,
    client.WAFNonexistentItemException,
    client.WAFOptimisticLockException,
    client.WAFServiceLinkedRoleErrorException,
    client.WAFSubscriptionNotFoundException,
    client.WAFTagOperationException,
    client.WAFTagOperationInternalErrorException,
    client.WAFUnavailableEntityException,
) as e:
    print(e)
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

Method definition
def associate_web_acl(
    self,
    *,
    WebACLArn: str,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

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

Method definition
def check_capacity(
    self,
    *,
    Scope: ScopeType,  # (1)
    Rules: Sequence[RuleTypeDef],  # (2)
) -> CheckCapacityResponseTypeDef:  # (3)
    ...
  1. See ScopeType
  2. See RuleTypeDef
  3. See CheckCapacityResponseTypeDef
Usage example with kwargs
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

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

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

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
Usage example with kwargs
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

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
Usage example with kwargs
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

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
Usage example with kwargs
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

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] = ...,
) -> CreateWebACLResponseTypeDef:  # (9)
    ...
  1. See ScopeType
  2. See DefaultActionTypeDef
  3. See VisibilityConfigTypeDef
  4. See RuleTypeDef
  5. See TagTypeDef
  6. See CustomResponseBodyTypeDef
  7. See CaptchaConfigTypeDef
  8. See ChallengeConfigTypeDef
  9. See CreateWebACLResponseTypeDef
Usage example with kwargs
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

Method definition
def delete_firewall_manager_rule_groups(
    self,
    *,
    WebACLArn: str,
    WebACLLockToken: str,
) -> DeleteFirewallManagerRuleGroupsResponseTypeDef:  # (1)
    ...
  1. See DeleteFirewallManagerRuleGroupsResponseTypeDef
Usage example with kwargs
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

Method definition
def delete_ip_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
) -> Dict[str, Any]:
    ...
  1. See ScopeType
Usage example with kwargs
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

Method definition
def delete_logging_configuration(
    self,
    *,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def delete_permission_policy(
    self,
    *,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def delete_regex_pattern_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
) -> Dict[str, Any]:
    ...
  1. See ScopeType
Usage example with kwargs
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

Method definition
def delete_rule_group(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
) -> Dict[str, Any]:
    ...
  1. See ScopeType
Usage example with kwargs
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

Method definition
def delete_web_acl(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
    LockToken: str,
) -> Dict[str, Any]:
    ...
  1. See ScopeType
Usage example with kwargs
kwargs: DeleteWebACLRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Scope": ...,
    "Id": ...,
    "LockToken": ...,
}

parent.delete_web_acl(**kwargs)
  1. See DeleteWebACLRequestRequestTypeDef

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

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
Usage example with kwargs
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

Method definition
def disassociate_web_acl(
    self,
    *,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def generate_mobile_sdk_release_url(
    self,
    *,
    Platform: PlatformType,  # (1)
    ReleaseVersion: str,
) -> GenerateMobileSdkReleaseUrlResponseTypeDef:  # (2)
    ...
  1. See PlatformType
  2. See GenerateMobileSdkReleaseUrlResponseTypeDef
Usage example with kwargs
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

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

get_ip_set

Retrieves the specified IPSet.

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

Method definition
def get_ip_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
) -> GetIPSetResponseTypeDef:  # (2)
    ...
  1. See ScopeType
  2. See GetIPSetResponseTypeDef
Usage example with kwargs
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

Method definition
def get_logging_configuration(
    self,
    *,
    ResourceArn: str,
) -> GetLoggingConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetLoggingConfigurationResponseTypeDef
Usage example with kwargs
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

Method definition
def get_managed_rule_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
) -> GetManagedRuleSetResponseTypeDef:  # (2)
    ...
  1. See ScopeType
  2. See GetManagedRuleSetResponseTypeDef
Usage example with kwargs
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

Method definition
def get_mobile_sdk_release(
    self,
    *,
    Platform: PlatformType,  # (1)
    ReleaseVersion: str,
) -> GetMobileSdkReleaseResponseTypeDef:  # (2)
    ...
  1. See PlatformType
  2. See GetMobileSdkReleaseResponseTypeDef
Usage example with kwargs
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

Method definition
def get_permission_policy(
    self,
    *,
    ResourceArn: str,
) -> GetPermissionPolicyResponseTypeDef:  # (1)
    ...
  1. See GetPermissionPolicyResponseTypeDef
Usage example with kwargs
kwargs: GetPermissionPolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_permission_policy(**kwargs)
  1. See GetPermissionPolicyRequestRequestTypeDef

get_rate_based_statement_managed_keys

Retrieves the keys 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

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
Usage example with kwargs
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

Method definition
def get_regex_pattern_set(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
) -> GetRegexPatternSetResponseTypeDef:  # (2)
    ...
  1. See ScopeType
  2. See GetRegexPatternSetResponseTypeDef
Usage example with kwargs
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

Method definition
def get_rule_group(
    self,
    *,
    Name: str = ...,
    Scope: ScopeType = ...,  # (1)
    Id: str = ...,
    ARN: str = ...,
) -> GetRuleGroupResponseTypeDef:  # (2)
    ...
  1. See ScopeType
  2. See GetRuleGroupResponseTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def get_web_acl(
    self,
    *,
    Name: str,
    Scope: ScopeType,  # (1)
    Id: str,
) -> GetWebACLResponseTypeDef:  # (2)
    ...
  1. See ScopeType
  2. See GetWebACLResponseTypeDef
Usage example with kwargs
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

Method definition
def get_web_acl_for_resource(
    self,
    *,
    ResourceArn: str,
) -> GetWebACLForResourceResponseTypeDef:  # (1)
    ...
  1. See GetWebACLForResourceResponseTypeDef
Usage example with kwargs
kwargs: GetWebACLForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_web_acl_for_resource(**kwargs)
  1. See GetWebACLForResourceRequestRequestTypeDef

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

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
Usage example with kwargs
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

Method definition
def list_available_managed_rule_groups(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListAvailableManagedRuleGroupsResponseTypeDef:  # (2)
    ...
  1. See ScopeType
  2. See ListAvailableManagedRuleGroupsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_ip_sets(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListIPSetsResponseTypeDef:  # (2)
    ...
  1. See ScopeType
  2. See ListIPSetsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_logging_configurations(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListLoggingConfigurationsResponseTypeDef:  # (2)
    ...
  1. See ScopeType
  2. See ListLoggingConfigurationsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_managed_rule_sets(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListManagedRuleSetsResponseTypeDef:  # (2)
    ...
  1. See ScopeType
  2. See ListManagedRuleSetsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_mobile_sdk_releases(
    self,
    *,
    Platform: PlatformType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListMobileSdkReleasesResponseTypeDef:  # (2)
    ...
  1. See PlatformType
  2. See ListMobileSdkReleasesResponseTypeDef
Usage example with kwargs
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

Method definition
def list_regex_pattern_sets(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListRegexPatternSetsResponseTypeDef:  # (2)
    ...
  1. See ScopeType
  2. See ListRegexPatternSetsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_resources_for_web_acl(
    self,
    *,
    WebACLArn: str,
    ResourceType: ResourceTypeType = ...,  # (1)
) -> ListResourcesForWebACLResponseTypeDef:  # (2)
    ...
  1. See ResourceTypeType
  2. See ListResourcesForWebACLResponseTypeDef
Usage example with kwargs
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

Method definition
def list_rule_groups(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListRuleGroupsResponseTypeDef:  # (2)
    ...
  1. See ScopeType
  2. See ListRuleGroupsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
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

Method definition
def list_web_acls(
    self,
    *,
    Scope: ScopeType,  # (1)
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListWebACLsResponseTypeDef:  # (2)
    ...
  1. See ScopeType
  2. See ListWebACLsResponseTypeDef
Usage example with kwargs
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

Method definition
def put_logging_configuration(
    self,
    *,
    LoggingConfiguration: LoggingConfigurationTypeDef,  # (1)
) -> PutLoggingConfigurationResponseTypeDef:  # (2)
    ...
  1. See LoggingConfigurationTypeDef
  2. See PutLoggingConfigurationResponseTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def put_permission_policy(
    self,
    *,
    ResourceArn: str,
    Policy: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: PutPermissionPolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...