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
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.
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)
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
def associate_web_acl(
self,
*,
WebACLArn: str,
ResourceArn: str,
) -> Dict[str, Any]:
...
kwargs: AssociateWebACLRequestRequestTypeDef = { # (1)
"WebACLArn": ...,
"ResourceArn": ...,
}
parent.associate_web_acl(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("wafv2").can_paginate
method.
boto3 documentation
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
def check_capacity(
self,
*,
Scope: ScopeType, # (1)
Rules: Sequence[RuleTypeDef], # (2)
) -> CheckCapacityResponseTypeDef: # (3)
...
- See ScopeType
- See RuleTypeDef
- See CheckCapacityResponseTypeDef
kwargs: CheckCapacityRequestRequestTypeDef = { # (1)
"Scope": ...,
"Rules": ...,
}
parent.check_capacity(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("wafv2").close
method.
boto3 documentation
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
def create_ip_set(
self,
*,
Name: str,
Scope: ScopeType, # (1)
IPAddressVersion: IPAddressVersionType, # (2)
Addresses: Sequence[str],
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateIPSetResponseTypeDef: # (4)
...
- See ScopeType
- See IPAddressVersionType
- See TagTypeDef
- See CreateIPSetResponseTypeDef
kwargs: CreateIPSetRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"IPAddressVersion": ...,
"Addresses": ...,
}
parent.create_ip_set(**kwargs)
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
def create_regex_pattern_set(
self,
*,
Name: str,
Scope: ScopeType, # (1)
RegularExpressionList: Sequence[RegexTypeDef], # (2)
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateRegexPatternSetResponseTypeDef: # (4)
...
- See ScopeType
- See RegexTypeDef
- See TagTypeDef
- See CreateRegexPatternSetResponseTypeDef
kwargs: CreateRegexPatternSetRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"RegularExpressionList": ...,
}
parent.create_regex_pattern_set(**kwargs)
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
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)
...
- See ScopeType
- See VisibilityConfigTypeDef
- See RuleTypeDef
- See TagTypeDef
- See CustomResponseBodyTypeDef
- See CreateRuleGroupResponseTypeDef
kwargs: CreateRuleGroupRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Capacity": ...,
"VisibilityConfig": ...,
}
parent.create_rule_group(**kwargs)
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
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)
...
- See ScopeType
- See DefaultActionTypeDef
- See VisibilityConfigTypeDef
- See RuleTypeDef
- See TagTypeDef
- See CustomResponseBodyTypeDef
- See CaptchaConfigTypeDef
- See ChallengeConfigTypeDef
- See CreateWebACLResponseTypeDef
kwargs: CreateWebACLRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"DefaultAction": ...,
"VisibilityConfig": ...,
}
parent.create_web_acl(**kwargs)
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
def delete_firewall_manager_rule_groups(
self,
*,
WebACLArn: str,
WebACLLockToken: str,
) -> DeleteFirewallManagerRuleGroupsResponseTypeDef: # (1)
...
kwargs: DeleteFirewallManagerRuleGroupsRequestRequestTypeDef = { # (1)
"WebACLArn": ...,
"WebACLLockToken": ...,
}
parent.delete_firewall_manager_rule_groups(**kwargs)
delete_ip_set
Deletes the specified IPSet.
Type annotations and code completion for boto3.client("wafv2").delete_ip_set
method.
boto3 documentation
def delete_ip_set(
self,
*,
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,
) -> Dict[str, Any]:
...
- See ScopeType
kwargs: DeleteIPSetRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
"LockToken": ...,
}
parent.delete_ip_set(**kwargs)
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
def delete_logging_configuration(
self,
*,
ResourceArn: str,
) -> Dict[str, Any]:
...
kwargs: DeleteLoggingConfigurationRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.delete_logging_configuration(**kwargs)
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
kwargs: DeletePermissionPolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.delete_permission_policy(**kwargs)
delete_regex_pattern_set
Deletes the specified RegexPatternSet.
Type annotations and code completion for boto3.client("wafv2").delete_regex_pattern_set
method.
boto3 documentation
def delete_regex_pattern_set(
self,
*,
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,
) -> Dict[str, Any]:
...
- See ScopeType
kwargs: DeleteRegexPatternSetRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
"LockToken": ...,
}
parent.delete_regex_pattern_set(**kwargs)
delete_rule_group
Deletes the specified RuleGroup.
Type annotations and code completion for boto3.client("wafv2").delete_rule_group
method.
boto3 documentation
def delete_rule_group(
self,
*,
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,
) -> Dict[str, Any]:
...
- See ScopeType
kwargs: DeleteRuleGroupRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
"LockToken": ...,
}
parent.delete_rule_group(**kwargs)
delete_web_acl
Deletes the specified WebACL.
Type annotations and code completion for boto3.client("wafv2").delete_web_acl
method.
boto3 documentation
def delete_web_acl(
self,
*,
Name: str,
Scope: ScopeType, # (1)
Id: str,
LockToken: str,
) -> Dict[str, Any]:
...
- See ScopeType
kwargs: DeleteWebACLRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
"LockToken": ...,
}
parent.delete_web_acl(**kwargs)
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
def describe_managed_rule_group(
self,
*,
VendorName: str,
Name: str,
Scope: ScopeType, # (1)
VersionName: str = ...,
) -> DescribeManagedRuleGroupResponseTypeDef: # (2)
...
kwargs: DescribeManagedRuleGroupRequestRequestTypeDef = { # (1)
"VendorName": ...,
"Name": ...,
"Scope": ...,
}
parent.describe_managed_rule_group(**kwargs)
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
kwargs: DisassociateWebACLRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.disassociate_web_acl(**kwargs)
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
def generate_mobile_sdk_release_url(
self,
*,
Platform: PlatformType, # (1)
ReleaseVersion: str,
) -> GenerateMobileSdkReleaseUrlResponseTypeDef: # (2)
...
kwargs: GenerateMobileSdkReleaseUrlRequestRequestTypeDef = { # (1)
"Platform": ...,
"ReleaseVersion": ...,
}
parent.generate_mobile_sdk_release_url(**kwargs)
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
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
def get_ip_set(
self,
*,
Name: str,
Scope: ScopeType, # (1)
Id: str,
) -> GetIPSetResponseTypeDef: # (2)
...
- See ScopeType
- See GetIPSetResponseTypeDef
kwargs: GetIPSetRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
}
parent.get_ip_set(**kwargs)
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
def get_logging_configuration(
self,
*,
ResourceArn: str,
) -> GetLoggingConfigurationResponseTypeDef: # (1)
...
kwargs: GetLoggingConfigurationRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.get_logging_configuration(**kwargs)
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
def get_managed_rule_set(
self,
*,
Name: str,
Scope: ScopeType, # (1)
Id: str,
) -> GetManagedRuleSetResponseTypeDef: # (2)
...
kwargs: GetManagedRuleSetRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
}
parent.get_managed_rule_set(**kwargs)
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
def get_mobile_sdk_release(
self,
*,
Platform: PlatformType, # (1)
ReleaseVersion: str,
) -> GetMobileSdkReleaseResponseTypeDef: # (2)
...
kwargs: GetMobileSdkReleaseRequestRequestTypeDef = { # (1)
"Platform": ...,
"ReleaseVersion": ...,
}
parent.get_mobile_sdk_release(**kwargs)
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
def get_permission_policy(
self,
*,
ResourceArn: str,
) -> GetPermissionPolicyResponseTypeDef: # (1)
...
kwargs: GetPermissionPolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.get_permission_policy(**kwargs)
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
def get_rate_based_statement_managed_keys(
self,
*,
Scope: ScopeType, # (1)
WebACLName: str,
WebACLId: str,
RuleName: str,
RuleGroupRuleName: str = ...,
) -> GetRateBasedStatementManagedKeysResponseTypeDef: # (2)
...
kwargs: GetRateBasedStatementManagedKeysRequestRequestTypeDef = { # (1)
"Scope": ...,
"WebACLName": ...,
"WebACLId": ...,
"RuleName": ...,
}
parent.get_rate_based_statement_managed_keys(**kwargs)
get_regex_pattern_set
Retrieves the specified RegexPatternSet.
Type annotations and code completion for boto3.client("wafv2").get_regex_pattern_set
method.
boto3 documentation
def get_regex_pattern_set(
self,
*,
Name: str,
Scope: ScopeType, # (1)
Id: str,
) -> GetRegexPatternSetResponseTypeDef: # (2)
...
kwargs: GetRegexPatternSetRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
}
parent.get_regex_pattern_set(**kwargs)
get_rule_group
Retrieves the specified RuleGroup.
Type annotations and code completion for boto3.client("wafv2").get_rule_group
method.
boto3 documentation
def get_rule_group(
self,
*,
Name: str = ...,
Scope: ScopeType = ..., # (1)
Id: str = ...,
ARN: str = ...,
) -> GetRuleGroupResponseTypeDef: # (2)
...
- See ScopeType
- See GetRuleGroupResponseTypeDef
kwargs: GetRuleGroupRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_rule_group(**kwargs)
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
def get_sampled_requests(
self,
*,
WebAclArn: str,
RuleMetricName: str,
Scope: ScopeType, # (1)
TimeWindow: TimeWindowTypeDef, # (2)
MaxItems: int,
) -> GetSampledRequestsResponseTypeDef: # (3)
...
kwargs: GetSampledRequestsRequestRequestTypeDef = { # (1)
"WebAclArn": ...,
"RuleMetricName": ...,
"Scope": ...,
"TimeWindow": ...,
"MaxItems": ...,
}
parent.get_sampled_requests(**kwargs)
get_web_acl
Retrieves the specified WebACL.
Type annotations and code completion for boto3.client("wafv2").get_web_acl
method.
boto3 documentation
def get_web_acl(
self,
*,
Name: str,
Scope: ScopeType, # (1)
Id: str,
) -> GetWebACLResponseTypeDef: # (2)
...
- See ScopeType
- See GetWebACLResponseTypeDef
kwargs: GetWebACLRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
}
parent.get_web_acl(**kwargs)
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
def get_web_acl_for_resource(
self,
*,
ResourceArn: str,
) -> GetWebACLForResourceResponseTypeDef: # (1)
...
kwargs: GetWebACLForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.get_web_acl_for_resource(**kwargs)
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
def list_available_managed_rule_group_versions(
self,
*,
VendorName: str,
Name: str,
Scope: ScopeType, # (1)
NextMarker: str = ...,
Limit: int = ...,
) -> ListAvailableManagedRuleGroupVersionsResponseTypeDef: # (2)
...
kwargs: ListAvailableManagedRuleGroupVersionsRequestRequestTypeDef = { # (1)
"VendorName": ...,
"Name": ...,
"Scope": ...,
}
parent.list_available_managed_rule_group_versions(**kwargs)
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
def list_available_managed_rule_groups(
self,
*,
Scope: ScopeType, # (1)
NextMarker: str = ...,
Limit: int = ...,
) -> ListAvailableManagedRuleGroupsResponseTypeDef: # (2)
...
kwargs: ListAvailableManagedRuleGroupsRequestRequestTypeDef = { # (1)
"Scope": ...,
}
parent.list_available_managed_rule_groups(**kwargs)
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
def list_ip_sets(
self,
*,
Scope: ScopeType, # (1)
NextMarker: str = ...,
Limit: int = ...,
) -> ListIPSetsResponseTypeDef: # (2)
...
- See ScopeType
- See ListIPSetsResponseTypeDef
kwargs: ListIPSetsRequestRequestTypeDef = { # (1)
"Scope": ...,
}
parent.list_ip_sets(**kwargs)
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
def list_logging_configurations(
self,
*,
Scope: ScopeType, # (1)
NextMarker: str = ...,
Limit: int = ...,
) -> ListLoggingConfigurationsResponseTypeDef: # (2)
...
kwargs: ListLoggingConfigurationsRequestRequestTypeDef = { # (1)
"Scope": ...,
}
parent.list_logging_configurations(**kwargs)
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
def list_managed_rule_sets(
self,
*,
Scope: ScopeType, # (1)
NextMarker: str = ...,
Limit: int = ...,
) -> ListManagedRuleSetsResponseTypeDef: # (2)
...
kwargs: ListManagedRuleSetsRequestRequestTypeDef = { # (1)
"Scope": ...,
}
parent.list_managed_rule_sets(**kwargs)
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
def list_mobile_sdk_releases(
self,
*,
Platform: PlatformType, # (1)
NextMarker: str = ...,
Limit: int = ...,
) -> ListMobileSdkReleasesResponseTypeDef: # (2)
...
kwargs: ListMobileSdkReleasesRequestRequestTypeDef = { # (1)
"Platform": ...,
}
parent.list_mobile_sdk_releases(**kwargs)
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
def list_regex_pattern_sets(
self,
*,
Scope: ScopeType, # (1)
NextMarker: str = ...,
Limit: int = ...,
) -> ListRegexPatternSetsResponseTypeDef: # (2)
...
kwargs: ListRegexPatternSetsRequestRequestTypeDef = { # (1)
"Scope": ...,
}
parent.list_regex_pattern_sets(**kwargs)
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
def list_resources_for_web_acl(
self,
*,
WebACLArn: str,
ResourceType: ResourceTypeType = ..., # (1)
) -> ListResourcesForWebACLResponseTypeDef: # (2)
...
kwargs: ListResourcesForWebACLRequestRequestTypeDef = { # (1)
"WebACLArn": ...,
}
parent.list_resources_for_web_acl(**kwargs)
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
def list_rule_groups(
self,
*,
Scope: ScopeType, # (1)
NextMarker: str = ...,
Limit: int = ...,
) -> ListRuleGroupsResponseTypeDef: # (2)
...
kwargs: ListRuleGroupsRequestRequestTypeDef = { # (1)
"Scope": ...,
}
parent.list_rule_groups(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceARN: str,
NextMarker: str = ...,
Limit: int = ...,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def list_web_acls(
self,
*,
Scope: ScopeType, # (1)
NextMarker: str = ...,
Limit: int = ...,
) -> ListWebACLsResponseTypeDef: # (2)
...
- See ScopeType
- See ListWebACLsResponseTypeDef
kwargs: ListWebACLsRequestRequestTypeDef = { # (1)
"Scope": ...,
}
parent.list_web_acls(**kwargs)
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
def put_logging_configuration(
self,
*,
LoggingConfiguration: LoggingConfigurationTypeDef, # (1)
) -> PutLoggingConfigurationResponseTypeDef: # (2)
...
kwargs: PutLoggingConfigurationRequestRequestTypeDef = { # (1)
"LoggingConfiguration": ...,
}
parent.put_logging_configuration(**kwargs)
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
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)
...
kwargs: PutManagedRuleSetVersionsRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
"LockToken": ...,
}
parent.put_managed_rule_set_versions(**kwargs)
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
def put_permission_policy(
self,
*,
ResourceArn: str,
Policy: str,
) -> Dict[str, Any]:
...
kwargs: PutPermissionPolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Policy": ...,
}
parent.put_permission_policy(**kwargs)
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
def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Disassociates tags from an Amazon Web Services resource.
Type annotations and code completion for boto3.client("wafv2").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_ip_set
Updates the specified IPSet.
Type annotations and code completion for boto3.client("wafv2").update_ip_set
method.
boto3 documentation
def update_ip_set(
self,
*,
Name: str,
Scope: ScopeType, # (1)
Id: str,
Addresses: Sequence[str],
LockToken: str,
Description: str = ...,
) -> UpdateIPSetResponseTypeDef: # (2)
...
- See ScopeType
- See UpdateIPSetResponseTypeDef
kwargs: UpdateIPSetRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
"Addresses": ...,
"LockToken": ...,
}
parent.update_ip_set(**kwargs)
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
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)
...
kwargs: UpdateManagedRuleSetVersionExpiryDateRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
"LockToken": ...,
"VersionToExpire": ...,
"ExpiryTimestamp": ...,
}
parent.update_managed_rule_set_version_expiry_date(**kwargs)
update_regex_pattern_set
Updates the specified RegexPatternSet.
Type annotations and code completion for boto3.client("wafv2").update_regex_pattern_set
method.
boto3 documentation
def update_regex_pattern_set(
self,
*,
Name: str,
Scope: ScopeType, # (1)
Id: str,
RegularExpressionList: Sequence[RegexTypeDef], # (2)
LockToken: str,
Description: str = ...,
) -> UpdateRegexPatternSetResponseTypeDef: # (3)
...
kwargs: UpdateRegexPatternSetRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
"RegularExpressionList": ...,
"LockToken": ...,
}
parent.update_regex_pattern_set(**kwargs)
update_rule_group
Updates the specified RuleGroup.
Type annotations and code completion for boto3.client("wafv2").update_rule_group
method.
boto3 documentation
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)
...
- See ScopeType
- See VisibilityConfigTypeDef
- See RuleTypeDef
- See CustomResponseBodyTypeDef
- See UpdateRuleGroupResponseTypeDef
kwargs: UpdateRuleGroupRequestRequestTypeDef = { # (1)
"Name": ...,
"Scope": ...,
"Id": ...,
"VisibilityConfig": ...,
"LockToken": ...,
}
parent.update_rule_group(**kwargs)
update_web_acl
Updates the specified WebACL.
Type annotations and code completion for boto3.client("wafv2").update_web_acl
method.
boto3 documentation
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] = ...,
) -> UpdateWebACLResponseTypeDef: # (8)
...