Skip to content

WAFRegionalClient#

Index > WAFRegional > WAFRegionalClient

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

WAFRegionalClient#

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

# WAFRegionalClient usage example

from boto3.session import Session
from mypy_boto3_waf_regional.client import WAFRegionalClient

def get_waf-regional_client() -> WAFRegionalClient:
    return Session().client("waf-regional")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("waf-regional")

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,
    client.exceptions.WAFUnavailableEntityException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_waf_regional.client import Exceptions

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

Methods#

associate_web_acl#

.

Type annotations and code completion for boto3.client("waf-regional").associate_web_acl method. boto3 documentation

# associate_web_acl method definition

def associate_web_acl(
    self,
    *,
    WebACLId: str,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...
# associate_web_acl method usage example with argument unpacking

kwargs: AssociateWebACLRequestRequestTypeDef = {  # (1)
    "WebACLId": ...,
    "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("waf-regional").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-regional").close method. boto3 documentation

# close method definition

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

create_byte_match_set#

.

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