Skip to content

WAFClient#

Index > WAF > WAFClient

Auto-generated documentation for WAF type annotations stubs module mypy-boto3-waf.

WAFClient#

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

# WAFClient usage example

from boto3.session import Session
from mypy_boto3_waf.client import WAFClient

def get_waf_client() -> WAFClient:
    return Session().client("waf")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("waf")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.WAFBadRequestException,
    client.exceptions.WAFDisallowedNameException,
    client.exceptions.WAFEntityMigrationException,
    client.exceptions.WAFInternalErrorException,
    client.exceptions.WAFInvalidAccountException,
    client.exceptions.WAFInvalidOperationException,
    client.exceptions.WAFInvalidParameterException,
    client.exceptions.WAFInvalidPermissionPolicyException,
    client.exceptions.WAFInvalidRegexPatternException,
    client.exceptions.WAFLimitsExceededException,
    client.exceptions.WAFNonEmptyEntityException,
    client.exceptions.WAFNonexistentContainerException,
    client.exceptions.WAFNonexistentItemException,
    client.exceptions.WAFReferencedItemException,
    client.exceptions.WAFServiceLinkedRoleErrorException,
    client.exceptions.WAFStaleDataException,
    client.exceptions.WAFSubscriptionNotFoundException,
    client.exceptions.WAFTagOperationException,
    client.exceptions.WAFTagOperationInternalErrorException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_waf.client import Exceptions

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

Methods#

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

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

# close method definition

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

create_byte_match_set#

.

Type annotations and code completion for boto3.client("waf").create_byte_match_set method. boto3 documentation

# create_byte_match_set method definition

def create_byte_match_set(
    self,
    *,
    Name: str,
    ChangeToken: str,
) -> CreateByteMatchSetResponseTypeDef:  # (1)
    ...
  1. See CreateByteMatchSetResponseTypeDef 
# create_byte_match_set method usage example with argument unpacking

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

parent.create_byte_match_set(**kwargs)
  1. See CreateByteMatchSetRequestRequestTypeDef

create_geo_match_set#

.

Type annotations and code completion for boto3.client("waf").create_geo_match_set method. boto3 documentation

# create_geo_match_set method definition

def create_geo_match_set(
    self,
    *,
    Name: str,
    ChangeToken: str,
) -> CreateGeoMatchSetResponseTypeDef:  # (1)
    ...
  1. See CreateGeoMatchSetResponseTypeDef 
# create_geo_match_set method usage example with argument unpacking

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

parent.create_geo_match_set(**kwargs)
  1. See CreateGeoMatchSetRequestRequestTypeDef

create_ip_set#

.

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

# create_ip_set method definition

def create_ip_set(
    self,
    *,
    Name: str,
    ChangeToken: str,
) -> CreateIPSetResponseTypeDef:  # (1)
    ...
  1. See CreateIPSetResponseTypeDef 
# create_ip_set method usage example with argument unpacking

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

parent.create_ip_set(**kwargs)
  1. See CreateIPSetRequestRequestTypeDef

create_rate_based_rule#

.

Type annotations and code completion for boto3.client("waf").create_rate_based_rule method. boto3 documentation

# create_rate_based_rule method definition

def create_rate_based_rule(
    self,
    *,
    Name: str,
    MetricName: str,
    RateKey: RateKeyType,  # (1)
    RateLimit: int,
    ChangeToken: str,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateRateBasedRuleResponseTypeDef:  # (3)
    ...
  1. See RateKeyType
  2. See TagTypeDef
  3. See CreateRateBasedRuleResponseTypeDef 
# create_rate_based_rule method usage example with argument unpacking

kwargs: CreateRateBasedRuleRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "MetricName": ...,
    "RateKey": ...,
    "RateLimit": ...,
    "ChangeToken": ...,
}

parent.create_rate_based_rule(**kwargs)
  1. See CreateRateBasedRuleRequestRequestTypeDef

create_regex_match_set#

.

Type annotations and code completion for boto3.client("waf").create_regex_match_set method. boto3 documentation

# create_regex_match_set method definition

def create_regex_match_set(
    self,
    *,
    Name: str,
    ChangeToken: str,
) -> CreateRegexMatchSetResponseTypeDef:  # (1)
    ...
  1. See CreateRegexMatchSetResponseTypeDef 
# create_regex_match_set method usage example with argument unpacking

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

parent.create_regex_match_set(**kwargs)
  1. See CreateRegexMatchSetRequestRequestTypeDef

create_regex_pattern_set#

.

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

# create_regex_pattern_set method definition

def create_regex_pattern_set(
    self,
    *,
    Name: str,
    ChangeToken: str,
) -> CreateRegexPatternSetResponseTypeDef:  # (1)
    ...
  1. See CreateRegexPatternSetResponseTypeDef 
# create_regex_pattern_set method usage example with argument unpacking

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

parent.create_regex_pattern_set(**kwargs)
  1. See CreateRegexPatternSetRequestRequestTypeDef

create_rule#

.

Type annotations and code completion for boto3.client("waf").create_rule method. boto3 documentation

# create_rule method definition

def create_rule(
    self,
    *,
    Name: str,
    MetricName: str,
    ChangeToken: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateRuleResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateRuleResponseTypeDef 
# create_rule method usage example with argument unpacking

kwargs: CreateRuleRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "MetricName": ...,
    "ChangeToken": ...,
}

parent.create_rule(**kwargs)
  1. See CreateRuleRequestRequestTypeDef

create_rule_group#

.

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

# create_rule_group method definition

def create_rule_group(
    self,
    *,
    Name: str,
    MetricName: str,
    ChangeToken: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateRuleGroupResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateRuleGroupResponseTypeDef 
# create_rule_group method usage example with argument unpacking

kwargs: CreateRuleGroupRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "MetricName": ...,
    "ChangeToken": ...,
}

parent.create_rule_group(**kwargs)
  1. See CreateRuleGroupRequestRequestTypeDef

create_size_constraint_set#

.

Type annotations and code completion for boto3.client("waf").create_size_constraint_set method. boto3 documentation

# create_size_constraint_set method definition

def create_size_constraint_set(
    self,
    *,
    Name: str,
    ChangeToken: str,
) -> CreateSizeConstraintSetResponseTypeDef:  # (1)
    ...
  1. See CreateSizeConstraintSetResponseTypeDef 
# create_size_constraint_set method usage example with argument unpacking

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

parent.create_size_constraint_set(**kwargs)
  1. See CreateSizeConstraintSetRequestRequestTypeDef

create_sql_injection_match_set#

.

Type annotations and code completion for boto3.client("waf").create_sql_injection_match_set method. boto3 documentation

# create_sql_injection_match_set method definition

def create_sql_injection_match_set(
    self,
    *,
    Name: str,
    ChangeToken: str,
) -> CreateSqlInjectionMatchSetResponseTypeDef:  # (1)
    ...
  1. See CreateSqlInjectionMatchSetResponseTypeDef 
# create_sql_injection_match_set method usage example with argument unpacking

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

parent.create_sql_injection_match_set(**kwargs)
  1. See CreateSqlInjectionMatchSetRequestRequestTypeDef

create_web_acl#

.

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

# create_web_acl method definition

def create_web_acl(
    self,
    *,
    Name: str,
    MetricName: str,
    DefaultAction: WafActionTypeDef,  # (1)
    ChangeToken: str,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateWebACLResponseTypeDef:  # (3)
    ...
  1. See WafActionTypeDef
  2. See TagTypeDef
  3. See CreateWebACLResponseTypeDef 
# create_web_acl method usage example with argument unpacking

kwargs: CreateWebACLRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "MetricName": ...,
    "DefaultAction": ...,
    "ChangeToken": ...,
}

parent.create_web_acl(**kwargs)
  1. See CreateWebACLRequestRequestTypeDef

create_web_acl_migration_stack#

Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket.

Type annotations and code completion for boto3.client("waf").create_web_acl_migration_stack method. boto3 documentation

# create_web_acl_migration_stack method definition

def create_web_acl_migration_stack(
    self,
    *,
    WebACLId: str,
    S3BucketName: str,
    IgnoreUnsupportedType: bool,
) -> CreateWebACLMigrationStackResponseTypeDef:  # (1)
    ...
  1. See CreateWebACLMigrationStackResponseTypeDef 
# create_web_acl_migration_stack method usage example with argument unpacking

kwargs: CreateWebACLMigrationStackRequestRequestTypeDef = {  # (1)
    "WebACLId": ...,
    "S3BucketName": ...,
    "IgnoreUnsupportedType": ...,
}

parent.create_web_acl_migration_stack(**kwargs)
  1. See CreateWebACLMigrationStackRequestRequestTypeDef

create_xss_match_set#

.

Type annotations and code completion for boto3.client("waf").create_xss_match_set method. boto3 documentation

# create_xss_match_set method definition

def create_xss_match_set(
    self,
    *,
    Name: str,
    ChangeToken: str,
) -> CreateXssMatchSetResponseTypeDef:  # (1)
    ...
  1. See CreateXssMatchSetResponseTypeDef 
# create_xss_match_set method usage example with argument unpacking

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

parent.create_xss_match_set(**kwargs)
  1. See CreateXssMatchSetRequestRequestTypeDef

delete_byte_match_set#

.

Type annotations and code completion for boto3.client("waf").delete_byte_match_set method. boto3 documentation

# delete_byte_match_set method definition

def delete_byte_match_set(
    self,
    *,
    ByteMatchSetId: str,
    ChangeToken: str,
) -> DeleteByteMatchSetResponseTypeDef:  # (1)
    ...
  1. See DeleteByteMatchSetResponseTypeDef 
# delete_byte_match_set method usage example with argument unpacking

kwargs: DeleteByteMatchSetRequestRequestTypeDef = {  # (1)
    "ByteMatchSetId": ...,
    "ChangeToken": ...,
}

parent.delete_byte_match_set(**kwargs)
  1. See DeleteByteMatchSetRequestRequestTypeDef

delete_geo_match_set#

.

Type annotations and code completion for boto3.client("waf").delete_geo_match_set method. boto3 documentation

# delete_geo_match_set method definition

def delete_geo_match_set(
    self,
    *,
    GeoMatchSetId: str,
    ChangeToken: str,
) -> DeleteGeoMatchSetResponseTypeDef:  # (1)
    ...
  1. See DeleteGeoMatchSetResponseTypeDef 
# delete_geo_match_set method usage example with argument unpacking

kwargs: DeleteGeoMatchSetRequestRequestTypeDef = {  # (1)
    "GeoMatchSetId": ...,
    "ChangeToken": ...,
}

parent.delete_geo_match_set(**kwargs)
  1. See DeleteGeoMatchSetRequestRequestTypeDef

delete_ip_set#

.

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

# delete_ip_set method definition

def delete_ip_set(
    self,
    *,
    IPSetId: str,
    ChangeToken: str,
) -> DeleteIPSetResponseTypeDef:  # (1)
    ...
  1. See DeleteIPSetResponseTypeDef 
# delete_ip_set method usage example with argument unpacking

kwargs: DeleteIPSetRequestRequestTypeDef = {  # (1)
    "IPSetId": ...,
    "ChangeToken": ...,
}

parent.delete_ip_set(**kwargs)
  1. See DeleteIPSetRequestRequestTypeDef

delete_logging_configuration#

.

Type annotations and code completion for boto3.client("waf").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#

.

Type annotations and code completion for boto3.client("waf").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_rate_based_rule#

.

Type annotations and code completion for boto3.client("waf").delete_rate_based_rule method. boto3 documentation

# delete_rate_based_rule method definition

def delete_rate_based_rule(
    self,
    *,
    RuleId: str,
    ChangeToken: str,
) -> DeleteRateBasedRuleResponseTypeDef:  # (1)
    ...
  1. See DeleteRateBasedRuleResponseTypeDef 
# delete_rate_based_rule method usage example with argument unpacking

kwargs: DeleteRateBasedRuleRequestRequestTypeDef = {  # (1)
    "RuleId": ...,
    "ChangeToken": ...,
}

parent.delete_rate_based_rule(**kwargs)
  1. See DeleteRateBasedRuleRequestRequestTypeDef

delete_regex_match_set#

.

Type annotations and code completion for boto3.client("waf").delete_regex_match_set method. boto3 documentation

# delete_regex_match_set method definition

def delete_regex_match_set(
    self,
    *,
    RegexMatchSetId: str,
    ChangeToken: str,
) -> DeleteRegexMatchSetResponseTypeDef:  # (1)
    ...
  1. See DeleteRegexMatchSetResponseTypeDef 
# delete_regex_match_set method usage example with argument unpacking

kwargs: DeleteRegexMatchSetRequestRequestTypeDef = {  # (1)
    "RegexMatchSetId": ...,
    "ChangeToken": ...,
}

parent.delete_regex_match_set(**kwargs)
  1. See DeleteRegexMatchSetRequestRequestTypeDef

delete_regex_pattern_set#

.

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

# delete_regex_pattern_set method definition

def delete_regex_pattern_set(
    self,
    *,
    RegexPatternSetId: str,
    ChangeToken: str,
) -> DeleteRegexPatternSetResponseTypeDef:  # (1)
    ...
  1. See DeleteRegexPatternSetResponseTypeDef 
# delete_regex_pattern_set method usage example with argument unpacking

kwargs: DeleteRegexPatternSetRequestRequestTypeDef = {  # (1)
    "RegexPatternSetId": ...,
    "ChangeToken": ...,
}

parent.delete_regex_pattern_set(**kwargs)
  1. See DeleteRegexPatternSetRequestRequestTypeDef

delete_rule#

.

Type annotations and code completion for boto3.client("waf").delete_rule method. boto3 documentation

# delete_rule method definition

def delete_rule(
    self,
    *,
    RuleId: str,
    ChangeToken: str,
) -> DeleteRuleResponseTypeDef:  # (1)
    ...
  1. See DeleteRuleResponseTypeDef 
# delete_rule method usage example with argument unpacking

kwargs: DeleteRuleRequestRequestTypeDef = {  # (1)
    "RuleId": ...,
    "ChangeToken": ...,
}

parent.delete_rule(**kwargs)
  1. See DeleteRuleRequestRequestTypeDef

delete_rule_group#

.

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

# delete_rule_group method definition

def delete_rule_group(
    self,
    *,
    RuleGroupId: str,
    ChangeToken: str,
) -> DeleteRuleGroupResponseTypeDef:  # (1)
    ...
  1. See DeleteRuleGroupResponseTypeDef 
# delete_rule_group method usage example with argument unpacking

kwargs: DeleteRuleGroupRequestRequestTypeDef = {  # (1)
    "RuleGroupId": ...,
    "ChangeToken": ...,
}

parent.delete_rule_group(**kwargs)
  1. See DeleteRuleGroupRequestRequestTypeDef

delete_size_constraint_set#

.

Type annotations and code completion for boto3.client("waf").delete_size_constraint_set method. boto3 documentation

# delete_size_constraint_set method definition

def delete_size_constraint_set(
    self,
    *,
    SizeConstraintSetId: str,
    ChangeToken: str,
) -> DeleteSizeConstraintSetResponseTypeDef:  # (1)
    ...
  1. See DeleteSizeConstraintSetResponseTypeDef 
# delete_size_constraint_set method usage example with argument unpacking

kwargs: DeleteSizeConstraintSetRequestRequestTypeDef = {  # (1)
    "SizeConstraintSetId": ...,
    "ChangeToken": ...,
}

parent.delete_size_constraint_set(**kwargs)
  1. See DeleteSizeConstraintSetRequestRequestTypeDef

delete_sql_injection_match_set#

.

Type annotations and code completion for boto3.client("waf").delete_sql_injection_match_set method. boto3 documentation

# delete_sql_injection_match_set method definition

def delete_sql_injection_match_set(
    self,
    *,
    SqlInjectionMatchSetId: str,
    ChangeToken: str,
) -> DeleteSqlInjectionMatchSetResponseTypeDef:  # (1)
    ...
  1. See DeleteSqlInjectionMatchSetResponseTypeDef 
# delete_sql_injection_match_set method usage example with argument unpacking

kwargs: DeleteSqlInjectionMatchSetRequestRequestTypeDef = {  # (1)
    "SqlInjectionMatchSetId": ...,
    "ChangeToken": ...,
}

parent.delete_sql_injection_match_set(**kwargs)
  1. See DeleteSqlInjectionMatchSetRequestRequestTypeDef

delete_web_acl#

.

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

# delete_web_acl method definition

def delete_web_acl(
    self,
    *,
    WebACLId: str,
    ChangeToken: str,
) -> DeleteWebACLResponseTypeDef:  # (1)
    ...
  1. See DeleteWebACLResponseTypeDef 
# delete_web_acl method usage example with argument unpacking

kwargs: DeleteWebACLRequestRequestTypeDef = {  # (1)
    "WebACLId": ...,
    "ChangeToken": ...,
}

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

delete_xss_match_set#

.

Type annotations and code completion for boto3.client("waf").delete_xss_match_set method. boto3 documentation

# delete_xss_match_set method definition

def delete_xss_match_set(
    self,
    *,
    XssMatchSetId: str,
    ChangeToken: str,
) -> DeleteXssMatchSetResponseTypeDef:  # (1)
    ...
  1. See DeleteXssMatchSetResponseTypeDef 
# delete_xss_match_set method usage example with argument unpacking

kwargs: DeleteXssMatchSetRequestRequestTypeDef = {  # (1)
    "XssMatchSetId": ...,
    "ChangeToken": ...,
}

parent.delete_xss_match_set(**kwargs)
  1. See DeleteXssMatchSetRequestRequestTypeDef

generate_presigned_url#

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

Type annotations and code completion for boto3.client("waf").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_byte_match_set#

.

Type annotations and code completion for boto3.client("waf").get_byte_match_set method. boto3 documentation

# get_byte_match_set method definition

def get_byte_match_set(
    self,
    *,
    ByteMatchSetId: str,
) -> GetByteMatchSetResponseTypeDef:  # (1)
    ...
  1. See GetByteMatchSetResponseTypeDef 
# get_byte_match_set method usage example with argument unpacking

kwargs: GetByteMatchSetRequestRequestTypeDef = {  # (1)
    "ByteMatchSetId": ...,
}

parent.get_byte_match_set(**kwargs)
  1. See GetByteMatchSetRequestRequestTypeDef

get_change_token#

.

Type annotations and code completion for boto3.client("waf").get_change_token method. boto3 documentation

# get_change_token method definition

def get_change_token(
    self,
) -> GetChangeTokenResponseTypeDef:  # (1)
    ...
  1. See GetChangeTokenResponseTypeDef

get_change_token_status#

.

Type annotations and code completion for boto3.client("waf").get_change_token_status method. boto3 documentation

# get_change_token_status method definition

def get_change_token_status(
    self,
    *,
    ChangeToken: str,
) -> GetChangeTokenStatusResponseTypeDef:  # (1)
    ...
  1. See GetChangeTokenStatusResponseTypeDef 
# get_change_token_status method usage example with argument unpacking

kwargs: GetChangeTokenStatusRequestRequestTypeDef = {  # (1)
    "ChangeToken": ...,
}

parent.get_change_token_status(**kwargs)
  1. See GetChangeTokenStatusRequestRequestTypeDef

get_geo_match_set#

.

Type annotations and code completion for boto3.client("waf").get_geo_match_set method. boto3 documentation

# get_geo_match_set method definition

def get_geo_match_set(
    self,
    *,
    GeoMatchSetId: str,
) -> GetGeoMatchSetResponseTypeDef:  # (1)
    ...
  1. See GetGeoMatchSetResponseTypeDef 
# get_geo_match_set method usage example with argument unpacking

kwargs: GetGeoMatchSetRequestRequestTypeDef = {  # (1)
    "GeoMatchSetId": ...,
}

parent.get_geo_match_set(**kwargs)
  1. See GetGeoMatchSetRequestRequestTypeDef

get_ip_set#

.

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

# get_ip_set method definition

def get_ip_set(
    self,
    *,
    IPSetId: str,
) -> GetIPSetResponseTypeDef:  # (1)
    ...
  1. See GetIPSetResponseTypeDef 
# get_ip_set method usage example with argument unpacking

kwargs: GetIPSetRequestRequestTypeDef = {  # (1)
    "IPSetId": ...,
}

parent.get_ip_set(**kwargs)
  1. See GetIPSetRequestRequestTypeDef

get_logging_configuration#

.

Type annotations and code completion for boto3.client("waf").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_permission_policy#

.

Type annotations and code completion for boto3.client("waf").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_rule#

.

Type annotations and code completion for boto3.client("waf").get_rate_based_rule method. boto3 documentation

# get_rate_based_rule method definition

def get_rate_based_rule(
    self,
    *,
    RuleId: str,
) -> GetRateBasedRuleResponseTypeDef:  # (1)
    ...
  1. See GetRateBasedRuleResponseTypeDef 
# get_rate_based_rule method usage example with argument unpacking

kwargs: GetRateBasedRuleRequestRequestTypeDef = {  # (1)
    "RuleId": ...,
}

parent.get_rate_based_rule(**kwargs)
  1. See GetRateBasedRuleRequestRequestTypeDef

get_rate_based_rule_managed_keys#

.

Type annotations and code completion for boto3.client("waf").get_rate_based_rule_managed_keys method. boto3 documentation

# get_rate_based_rule_managed_keys method definition

def get_rate_based_rule_managed_keys(
    self,
    *,
    RuleId: str,
    NextMarker: str = ...,
) -> GetRateBasedRuleManagedKeysResponseTypeDef:  # (1)
    ...
  1. See GetRateBasedRuleManagedKeysResponseTypeDef 
# get_rate_based_rule_managed_keys method usage example with argument unpacking

kwargs: GetRateBasedRuleManagedKeysRequestRequestTypeDef = {  # (1)
    "RuleId": ...,
}

parent.get_rate_based_rule_managed_keys(**kwargs)
  1. See GetRateBasedRuleManagedKeysRequestRequestTypeDef

get_regex_match_set#

.

Type annotations and code completion for boto3.client("waf").get_regex_match_set method. boto3 documentation

# get_regex_match_set method definition

def get_regex_match_set(
    self,
    *,
    RegexMatchSetId: str,
) -> GetRegexMatchSetResponseTypeDef:  # (1)
    ...
  1. See GetRegexMatchSetResponseTypeDef 
# get_regex_match_set method usage example with argument unpacking

kwargs: GetRegexMatchSetRequestRequestTypeDef = {  # (1)
    "RegexMatchSetId": ...,
}

parent.get_regex_match_set(**kwargs)
  1. See GetRegexMatchSetRequestRequestTypeDef

get_regex_pattern_set#

.

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

# get_regex_pattern_set method definition

def get_regex_pattern_set(
    self,
    *,
    RegexPatternSetId: str,
) -> GetRegexPatternSetResponseTypeDef:  # (1)
    ...
  1. See GetRegexPatternSetResponseTypeDef 
# get_regex_pattern_set method usage example with argument unpacking

kwargs: GetRegexPatternSetRequestRequestTypeDef = {  # (1)
    "RegexPatternSetId": ...,
}

parent.get_regex_pattern_set(**kwargs)
  1. See GetRegexPatternSetRequestRequestTypeDef

get_rule#

.

Type annotations and code completion for boto3.client("waf").get_rule method. boto3 documentation

# get_rule method definition

def get_rule(
    self,
    *,
    RuleId: str,
) -> GetRuleResponseTypeDef:  # (1)
    ...
  1. See GetRuleResponseTypeDef 
# get_rule method usage example with argument unpacking

kwargs: GetRuleRequestRequestTypeDef = {  # (1)
    "RuleId": ...,
}

parent.get_rule(**kwargs)
  1. See GetRuleRequestRequestTypeDef

get_rule_group#

.

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

# get_rule_group method definition

def get_rule_group(
    self,
    *,
    RuleGroupId: str,
) -> GetRuleGroupResponseTypeDef:  # (1)
    ...
  1. See GetRuleGroupResponseTypeDef 
# get_rule_group method usage example with argument unpacking

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

parent.get_rule_group(**kwargs)
  1. See GetRuleGroupRequestRequestTypeDef

get_sampled_requests#

.

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

# get_sampled_requests method definition

def get_sampled_requests(
    self,
    *,
    WebAclId: str,
    RuleId: str,
    TimeWindow: TimeWindowTypeDef,  # (1)
    MaxItems: int,
) -> GetSampledRequestsResponseTypeDef:  # (2)
    ...
  1. See TimeWindowTypeDef
  2. See GetSampledRequestsResponseTypeDef 
# get_sampled_requests method usage example with argument unpacking

kwargs: GetSampledRequestsRequestRequestTypeDef = {  # (1)
    "WebAclId": ...,
    "RuleId": ...,
    "TimeWindow": ...,
    "MaxItems": ...,
}

parent.get_sampled_requests(**kwargs)
  1. See GetSampledRequestsRequestRequestTypeDef

get_size_constraint_set#

.

Type annotations and code completion for boto3.client("waf").get_size_constraint_set method. boto3 documentation

# get_size_constraint_set method definition

def get_size_constraint_set(
    self,
    *,
    SizeConstraintSetId: str,
) -> GetSizeConstraintSetResponseTypeDef:  # (1)
    ...
  1. See GetSizeConstraintSetResponseTypeDef 
# get_size_constraint_set method usage example with argument unpacking

kwargs: GetSizeConstraintSetRequestRequestTypeDef = {  # (1)
    "SizeConstraintSetId": ...,
}

parent.get_size_constraint_set(**kwargs)
  1. See GetSizeConstraintSetRequestRequestTypeDef

get_sql_injection_match_set#

.

Type annotations and code completion for boto3.client("waf").get_sql_injection_match_set method. boto3 documentation

# get_sql_injection_match_set method definition

def get_sql_injection_match_set(
    self,
    *,
    SqlInjectionMatchSetId: str,
) -> GetSqlInjectionMatchSetResponseTypeDef:  # (1)
    ...
  1. See GetSqlInjectionMatchSetResponseTypeDef 
# get_sql_injection_match_set method usage example with argument unpacking

kwargs: GetSqlInjectionMatchSetRequestRequestTypeDef = {  # (1)
    "SqlInjectionMatchSetId": ...,
}

parent.get_sql_injection_match_set(**kwargs)
  1. See GetSqlInjectionMatchSetRequestRequestTypeDef

get_web_acl#

.

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

# get_web_acl method definition

def get_web_acl(
    self,
    *,
    WebACLId: str,
) -> GetWebACLResponseTypeDef:  # (1)
    ...
  1. See GetWebACLResponseTypeDef 
# get_web_acl method usage example with argument unpacking

kwargs: GetWebACLRequestRequestTypeDef = {  # (1)
    "WebACLId": ...,
}

parent.get_web_acl(**kwargs)
  1. See GetWebACLRequestRequestTypeDef

get_xss_match_set#

.

Type annotations and code completion for boto3.client("waf").get_xss_match_set method. boto3 documentation

# get_xss_match_set method definition

def get_xss_match_set(
    self,
    *,
    XssMatchSetId: str,
) -> GetXssMatchSetResponseTypeDef:  # (1)
    ...
  1. See GetXssMatchSetResponseTypeDef 
# get_xss_match_set method usage example with argument unpacking

kwargs: GetXssMatchSetRequestRequestTypeDef = {  # (1)
    "XssMatchSetId": ...,
}

parent.get_xss_match_set(**kwargs)
  1. See GetXssMatchSetRequestRequestTypeDef

list_activated_rules_in_rule_group#

.

Type annotations and code completion for boto3.client("waf").list_activated_rules_in_rule_group method. boto3 documentation

# list_activated_rules_in_rule_group method definition

def list_activated_rules_in_rule_group(
    self,
    *,
    RuleGroupId: str = ...,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListActivatedRulesInRuleGroupResponseTypeDef:  # (1)
    ...
  1. See ListActivatedRulesInRuleGroupResponseTypeDef 
# list_activated_rules_in_rule_group method usage example with argument unpacking

kwargs: ListActivatedRulesInRuleGroupRequestRequestTypeDef = {  # (1)
    "RuleGroupId": ...,
}

parent.list_activated_rules_in_rule_group(**kwargs)
  1. See ListActivatedRulesInRuleGroupRequestRequestTypeDef

list_byte_match_sets#

.

Type annotations and code completion for boto3.client("waf").list_byte_match_sets method. boto3 documentation

# list_byte_match_sets method definition

def list_byte_match_sets(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListByteMatchSetsResponseTypeDef:  # (1)
    ...
  1. See ListByteMatchSetsResponseTypeDef 
# list_byte_match_sets method usage example with argument unpacking

kwargs: ListByteMatchSetsRequestRequestTypeDef = {  # (1)
    "NextMarker": ...,
}

parent.list_byte_match_sets(**kwargs)
  1. See ListByteMatchSetsRequestRequestTypeDef

list_geo_match_sets#

.

Type annotations and code completion for boto3.client("waf").list_geo_match_sets method. boto3 documentation

# list_geo_match_sets method definition

def list_geo_match_sets(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListGeoMatchSetsResponseTypeDef:  # (1)
    ...
  1. See ListGeoMatchSetsResponseTypeDef 
# list_geo_match_sets method usage example with argument unpacking

kwargs: ListGeoMatchSetsRequestRequestTypeDef = {  # (1)
    "NextMarker": ...,
}

parent.list_geo_match_sets(**kwargs)
  1. See ListGeoMatchSetsRequestRequestTypeDef

list_ip_sets#

.

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

# list_ip_sets method definition

def list_ip_sets(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListIPSetsResponseTypeDef:  # (1)
    ...
  1. See ListIPSetsResponseTypeDef 
# list_ip_sets method usage example with argument unpacking

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

parent.list_ip_sets(**kwargs)
  1. See ListIPSetsRequestRequestTypeDef

list_logging_configurations#

.

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

# list_logging_configurations method definition

def list_logging_configurations(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListLoggingConfigurationsResponseTypeDef:  # (1)
    ...
  1. See ListLoggingConfigurationsResponseTypeDef 
# list_logging_configurations method usage example with argument unpacking

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

parent.list_logging_configurations(**kwargs)
  1. See ListLoggingConfigurationsRequestRequestTypeDef

list_rate_based_rules#

.

Type annotations and code completion for boto3.client("waf").list_rate_based_rules method. boto3 documentation

# list_rate_based_rules method definition

def list_rate_based_rules(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListRateBasedRulesResponseTypeDef:  # (1)
    ...
  1. See ListRateBasedRulesResponseTypeDef 
# list_rate_based_rules method usage example with argument unpacking

kwargs: ListRateBasedRulesRequestRequestTypeDef = {  # (1)
    "NextMarker": ...,
}

parent.list_rate_based_rules(**kwargs)
  1. See ListRateBasedRulesRequestRequestTypeDef

list_regex_match_sets#

.

Type annotations and code completion for boto3.client("waf").list_regex_match_sets method. boto3 documentation

# list_regex_match_sets method definition

def list_regex_match_sets(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListRegexMatchSetsResponseTypeDef:  # (1)
    ...
  1. See ListRegexMatchSetsResponseTypeDef 
# list_regex_match_sets method usage example with argument unpacking

kwargs: ListRegexMatchSetsRequestRequestTypeDef = {  # (1)
    "NextMarker": ...,
}

parent.list_regex_match_sets(**kwargs)
  1. See ListRegexMatchSetsRequestRequestTypeDef

list_regex_pattern_sets#

.

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

# list_regex_pattern_sets method definition

def list_regex_pattern_sets(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListRegexPatternSetsResponseTypeDef:  # (1)
    ...
  1. See ListRegexPatternSetsResponseTypeDef 
# list_regex_pattern_sets method usage example with argument unpacking

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

parent.list_regex_pattern_sets(**kwargs)
  1. See ListRegexPatternSetsRequestRequestTypeDef

list_rule_groups#

.

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

# list_rule_groups method definition

def list_rule_groups(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListRuleGroupsResponseTypeDef:  # (1)
    ...
  1. See ListRuleGroupsResponseTypeDef 
# list_rule_groups method usage example with argument unpacking

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

parent.list_rule_groups(**kwargs)
  1. See ListRuleGroupsRequestRequestTypeDef

list_rules#

.

Type annotations and code completion for boto3.client("waf").list_rules method. boto3 documentation

# list_rules method definition

def list_rules(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListRulesResponseTypeDef:  # (1)
    ...
  1. See ListRulesResponseTypeDef 
# list_rules method usage example with argument unpacking

kwargs: ListRulesRequestRequestTypeDef = {  # (1)
    "NextMarker": ...,
}

parent.list_rules(**kwargs)
  1. See ListRulesRequestRequestTypeDef

list_size_constraint_sets#

.

Type annotations and code completion for boto3.client("waf").list_size_constraint_sets method. boto3 documentation

# list_size_constraint_sets method definition

def list_size_constraint_sets(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListSizeConstraintSetsResponseTypeDef:  # (1)
    ...
  1. See ListSizeConstraintSetsResponseTypeDef 
# list_size_constraint_sets method usage example with argument unpacking

kwargs: ListSizeConstraintSetsRequestRequestTypeDef = {  # (1)
    "NextMarker": ...,
}

parent.list_size_constraint_sets(**kwargs)
  1. See ListSizeConstraintSetsRequestRequestTypeDef

list_sql_injection_match_sets#

.

Type annotations and code completion for boto3.client("waf").list_sql_injection_match_sets method. boto3 documentation

# list_sql_injection_match_sets method definition

def list_sql_injection_match_sets(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListSqlInjectionMatchSetsResponseTypeDef:  # (1)
    ...
  1. See ListSqlInjectionMatchSetsResponseTypeDef 
# list_sql_injection_match_sets method usage example with argument unpacking

kwargs: ListSqlInjectionMatchSetsRequestRequestTypeDef = {  # (1)
    "NextMarker": ...,
}

parent.list_sql_injection_match_sets(**kwargs)
  1. See ListSqlInjectionMatchSetsRequestRequestTypeDef

list_subscribed_rule_groups#

.

Type annotations and code completion for boto3.client("waf").list_subscribed_rule_groups method. boto3 documentation

# list_subscribed_rule_groups method definition

def list_subscribed_rule_groups(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListSubscribedRuleGroupsResponseTypeDef:  # (1)
    ...
  1. See ListSubscribedRuleGroupsResponseTypeDef 
# list_subscribed_rule_groups method usage example with argument unpacking

kwargs: ListSubscribedRuleGroupsRequestRequestTypeDef = {  # (1)
    "NextMarker": ...,
}

parent.list_subscribed_rule_groups(**kwargs)
  1. See ListSubscribedRuleGroupsRequestRequestTypeDef

list_tags_for_resource#

.

Type annotations and code completion for boto3.client("waf").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#

.

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

# list_web_acls method definition

def list_web_acls(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListWebACLsResponseTypeDef:  # (1)
    ...
  1. See ListWebACLsResponseTypeDef 
# list_web_acls method usage example with argument unpacking

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

parent.list_web_acls(**kwargs)
  1. See ListWebACLsRequestRequestTypeDef

list_xss_match_sets#

.

Type annotations and code completion for boto3.client("waf").list_xss_match_sets method. boto3 documentation

# list_xss_match_sets method definition

def list_xss_match_sets(
    self,
    *,
    NextMarker: str = ...,
    Limit: int = ...,
) -> ListXssMatchSetsResponseTypeDef:  # (1)
    ...
  1. See ListXssMatchSetsResponseTypeDef 
# list_xss_match_sets method usage example with argument unpacking

kwargs: ListXssMatchSetsRequestRequestTypeDef = {  # (1)
    "NextMarker": ...,
}

parent.list_xss_match_sets(**kwargs)
  1. See ListXssMatchSetsRequestRequestTypeDef

put_logging_configuration#

.

Type annotations and code completion for boto3.client("waf").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_permission_policy#

.

Type annotations and code completion for boto3.client("waf").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#

.

Type annotations and code completion for boto3.client("waf").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#

.

Type annotations and code completion for boto3.client("waf").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_byte_match_set#

.

Type annotations and code completion for boto3.client("waf").update_byte_match_set method.