# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.WAFRegional do
@moduledoc """
This is **AWS WAF Classic Regional** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
This is the *AWS WAF Regional Classic API Reference* for using AWS WAF Classic
with the AWS resources, Elastic Load Balancing (ELB) Application Load Balancers
and API Gateway APIs. The AWS WAF Classic actions and data types listed in the
reference are available for protecting Elastic Load Balancing (ELB) Application
Load Balancers and API Gateway APIs. You can use these actions and data types by
means of the endpoints listed in [AWS Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#waf_region).
This guide is for developers who need detailed information about the AWS WAF
Classic API actions, data types, and errors. For detailed information about AWS
WAF Classic features and an overview of how to use the AWS WAF Classic API, see
the
[AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
get_sampled_requests_request() :: %{
required("MaxItems") => float(),
required("RuleId") => String.t() | atom(),
required("TimeWindow") => time_window(),
required("WebAclId") => String.t() | atom()
}
"""
@type get_sampled_requests_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
regex_match_set_update() :: %{
"Action" => list(any()),
"RegexMatchTuple" => regex_match_tuple()
}
"""
@type regex_match_set_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_geo_match_set_request() :: %{
required("GeoMatchSetId") => String.t() | atom()
}
"""
@type get_geo_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_web_acl_response() :: %{}
"""
@type associate_web_acl_response() :: %{}
@typedoc """
## Example:
xss_match_set() :: %{
"Name" => String.t() | atom(),
"XssMatchSetId" => String.t() | atom(),
"XssMatchTuples" => list(xss_match_tuple())
}
"""
@type xss_match_set() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_rule_request() :: %{
optional("Tags") => list(tag()),
required("ChangeToken") => String.t() | atom(),
required("MetricName") => String.t() | atom(),
required("Name") => String.t() | atom()
}
"""
@type create_rule_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sql_injection_match_set_summary() :: %{
"Name" => String.t() | atom(),
"SqlInjectionMatchSetId" => String.t() | atom()
}
"""
@type sql_injection_match_set_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
regex_pattern_set_update() :: %{
"Action" => list(any()),
"RegexPatternString" => String.t() | atom()
}
"""
@type regex_pattern_set_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_rule_group_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type update_rule_group_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("ResourceARN") => String.t() | atom(),
required("Tags") => list(tag())
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_nonexistent_item_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_nonexistent_item_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sql_injection_match_set() :: %{
"Name" => String.t() | atom(),
"SqlInjectionMatchSetId" => String.t() | atom(),
"SqlInjectionMatchTuples" => list(sql_injection_match_tuple())
}
"""
@type sql_injection_match_set() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rate_based_rule() :: %{
"MatchPredicates" => list(predicate()),
"MetricName" => String.t() | atom(),
"Name" => String.t() | atom(),
"RateKey" => list(any()),
"RateLimit" => float(),
"RuleId" => String.t() | atom()
}
"""
@type rate_based_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_resources_for_web_acl_request() :: %{
optional("ResourceType") => list(any()),
required("WebACLId") => String.t() | atom()
}
"""
@type list_resources_for_web_acl_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_size_constraint_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("SizeConstraintSetId") => String.t() | atom(),
required("Updates") => list(size_constraint_set_update())
}
"""
@type update_size_constraint_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
geo_match_set_update() :: %{
"Action" => list(any()),
"GeoMatchConstraint" => geo_match_constraint()
}
"""
@type geo_match_set_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
xss_match_set_update() :: %{
"Action" => list(any()),
"XssMatchTuple" => xss_match_tuple()
}
"""
@type xss_match_set_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_invalid_regex_pattern_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_invalid_regex_pattern_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_rule_group_request() :: %{
required("RuleGroupId") => String.t() | atom()
}
"""
@type get_rule_group_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_byte_match_set_response() :: %{
"ByteMatchSet" => byte_match_set(),
"ChangeToken" => String.t() | atom()
}
"""
@type create_byte_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_byte_match_set_response() :: %{
"ByteMatchSet" => byte_match_set()
}
"""
@type get_byte_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_rule_groups_response() :: %{
"NextMarker" => String.t() | atom(),
"RuleGroups" => list(rule_group_summary())
}
"""
@type list_rule_groups_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_ip_sets_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_ip_sets_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_byte_match_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type delete_byte_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
waf_action() :: %{
"Type" => list(any())
}
"""
@type waf_action() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_regex_match_sets_response() :: %{
"NextMarker" => String.t() | atom(),
"RegexMatchSets" => list(regex_match_set_summary())
}
"""
@type list_regex_match_sets_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_xss_match_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type delete_xss_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_regex_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("RegexMatchSetId") => String.t() | atom()
}
"""
@type delete_regex_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_xss_match_set_response() :: %{
"XssMatchSet" => xss_match_set()
}
"""
@type get_xss_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_stale_data_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_stale_data_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_xss_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("XssMatchSetId") => String.t() | atom()
}
"""
@type delete_xss_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_byte_match_set_request() :: %{
required("ByteMatchSetId") => String.t() | atom(),
required("ChangeToken") => String.t() | atom()
}
"""
@type delete_byte_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
list_xss_match_sets_response() :: %{
"NextMarker" => String.t() | atom(),
"XssMatchSets" => list(xss_match_set_summary())
}
"""
@type list_xss_match_sets_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_rate_based_rules_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_rate_based_rules_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_byte_match_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type update_byte_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_sql_injection_match_set_response() :: %{
"ChangeToken" => String.t() | atom(),
"SqlInjectionMatchSet" => sql_injection_match_set()
}
"""
@type create_sql_injection_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_rate_based_rule_request() :: %{
required("RuleId") => String.t() | atom()
}
"""
@type get_rate_based_rule_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
field_to_match() :: %{
"Data" => String.t() | atom(),
"Type" => list(any())
}
"""
@type field_to_match() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_service_linked_role_error_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_service_linked_role_error_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_nonexistent_container_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_nonexistent_container_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_byte_match_set_request() :: %{
required("ByteMatchSetId") => String.t() | atom(),
required("ChangeToken") => String.t() | atom(),
required("Updates") => list(byte_match_set_update())
}
"""
@type update_byte_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_geo_match_set_response() :: %{
"ChangeToken" => String.t() | atom(),
"GeoMatchSet" => geo_match_set()
}
"""
@type create_geo_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_ip_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type update_ip_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_web_acl_request() :: %{
required("ResourceArn") => String.t() | atom(),
required("WebACLId") => String.t() | atom()
}
"""
@type associate_web_acl_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rule_group() :: %{
"MetricName" => String.t() | atom(),
"Name" => String.t() | atom(),
"RuleGroupId" => String.t() | atom()
}
"""
@type rule_group() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
size_constraint() :: %{
"ComparisonOperator" => list(any()),
"FieldToMatch" => field_to_match(),
"Size" => float(),
"TextTransformation" => list(any())
}
"""
@type size_constraint() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_rule_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("RuleId") => String.t() | atom(),
required("Updates") => list(rule_update())
}
"""
@type update_rule_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_web_acl_for_resource_request() :: %{
required("ResourceArn") => String.t() | atom()
}
"""
@type get_web_acl_for_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_sql_injection_match_set_request() :: %{
required("SqlInjectionMatchSetId") => String.t() | atom()
}
"""
@type get_sql_injection_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_ip_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("IPSetId") => String.t() | atom()
}
"""
@type delete_ip_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_size_constraint_set_response() :: %{
"SizeConstraintSet" => size_constraint_set()
}
"""
@type get_size_constraint_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_rule_request() :: %{
required("RuleId") => String.t() | atom()
}
"""
@type get_rule_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
byte_match_set_update() :: %{
"Action" => list(any()),
"ByteMatchTuple" => byte_match_tuple()
}
"""
@type byte_match_set_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_rule_group_response() :: %{
"RuleGroup" => rule_group()
}
"""
@type get_rule_group_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_unavailable_entity_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_unavailable_entity_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_regex_pattern_set_request() :: %{
required("RegexPatternSetId") => String.t() | atom()
}
"""
@type get_regex_pattern_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_web_acl_response() :: %{
"WebACL" => web_acl()
}
"""
@type get_web_acl_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("ResourceARN") => String.t() | atom(),
required("TagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_info_for_resource() :: %{
"ResourceARN" => String.t() | atom(),
"TagList" => list(tag())
}
"""
@type tag_info_for_resource() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
activated_rule() :: %{
"Action" => waf_action(),
"ExcludedRules" => list(excluded_rule()),
"OverrideAction" => waf_override_action(),
"Priority" => integer(),
"RuleId" => String.t() | atom(),
"Type" => list(any())
}
"""
@type activated_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_invalid_permission_policy_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_invalid_permission_policy_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_rate_based_rule_response() :: %{
"ChangeToken" => String.t() | atom(),
"Rule" => rate_based_rule()
}
"""
@type create_rate_based_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_ip_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("IPSetId") => String.t() | atom(),
required("Updates") => list(ip_set_update())
}
"""
@type update_ip_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_rules_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_rules_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_size_constraint_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("Name") => String.t() | atom()
}
"""
@type create_size_constraint_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_rate_based_rule_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type update_rate_based_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_sql_injection_match_set_response() :: %{
"SqlInjectionMatchSet" => sql_injection_match_set()
}
"""
@type get_sql_injection_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
logging_configuration() :: %{
"LogDestinationConfigs" => list(String.t() | atom()),
"RedactedFields" => list(field_to_match()),
"ResourceArn" => String.t() | atom()
}
"""
@type logging_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_regex_match_set_request() :: %{
required("RegexMatchSetId") => String.t() | atom()
}
"""
@type get_regex_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
byte_match_tuple() :: %{
"FieldToMatch" => field_to_match(),
"PositionalConstraint" => list(any()),
"TargetString" => binary(),
"TextTransformation" => list(any())
}
"""
@type byte_match_tuple() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_sql_injection_match_sets_response() :: %{
"NextMarker" => String.t() | atom(),
"SqlInjectionMatchSets" => list(sql_injection_match_set_summary())
}
"""
@type list_sql_injection_match_sets_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_rule_group_response() :: %{
"ChangeToken" => String.t() | atom(),
"RuleGroup" => rule_group()
}
"""
@type create_rule_group_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_rule_group_request() :: %{
optional("Tags") => list(tag()),
required("ChangeToken") => String.t() | atom(),
required("MetricName") => String.t() | atom(),
required("Name") => String.t() | atom()
}
"""
@type create_rule_group_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_logging_configuration_response() :: %{
"LoggingConfiguration" => logging_configuration()
}
"""
@type put_logging_configuration_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_rule_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("RuleId") => String.t() | atom()
}
"""
@type delete_rule_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_bad_request_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_bad_request_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_geo_match_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type delete_geo_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_rule_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type delete_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_regex_pattern_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("RegexPatternSetId") => String.t() | atom()
}
"""
@type delete_regex_pattern_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_geo_match_sets_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_geo_match_sets_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
web_acl() :: %{
"DefaultAction" => waf_action(),
"MetricName" => String.t() | atom(),
"Name" => String.t() | atom(),
"Rules" => list(activated_rule()),
"WebACLArn" => String.t() | atom(),
"WebACLId" => String.t() | atom()
}
"""
@type web_acl() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_internal_error_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_internal_error_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
regex_match_set() :: %{
"Name" => String.t() | atom(),
"RegexMatchSetId" => String.t() | atom(),
"RegexMatchTuples" => list(regex_match_tuple())
}
"""
@type regex_match_set() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_activated_rules_in_rule_group_response() :: %{
"ActivatedRules" => list(activated_rule()),
"NextMarker" => String.t() | atom()
}
"""
@type list_activated_rules_in_rule_group_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_sql_injection_match_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type update_sql_injection_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
subscribed_rule_group_summary() :: %{
"MetricName" => String.t() | atom(),
"Name" => String.t() | atom(),
"RuleGroupId" => String.t() | atom()
}
"""
@type subscribed_rule_group_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_geo_match_set_response() :: %{
"GeoMatchSet" => geo_match_set()
}
"""
@type get_geo_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_permission_policy_response() :: %{}
"""
@type delete_permission_policy_response() :: %{}
@typedoc """
## Example:
delete_size_constraint_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("SizeConstraintSetId") => String.t() | atom()
}
"""
@type delete_size_constraint_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_rate_based_rule_managed_keys_request() :: %{
optional("NextMarker") => String.t() | atom(),
required("RuleId") => String.t() | atom()
}
"""
@type get_rate_based_rule_managed_keys_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_rule_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type update_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_referenced_item_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_referenced_item_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_regex_pattern_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("RegexPatternSetId") => String.t() | atom(),
required("Updates") => list(regex_pattern_set_update())
}
"""
@type update_regex_pattern_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_rate_based_rule_response() :: %{
"Rule" => rate_based_rule()
}
"""
@type get_rate_based_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
time_window() :: %{
"EndTime" => non_neg_integer(),
"StartTime" => non_neg_integer()
}
"""
@type time_window() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_ip_sets_response() :: %{
"IPSets" => list(ip_set_summary()),
"NextMarker" => String.t() | atom()
}
"""
@type list_ip_sets_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_subscribed_rule_groups_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_subscribed_rule_groups_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_xss_match_set_request() :: %{
required("XssMatchSetId") => String.t() | atom()
}
"""
@type get_xss_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag() :: %{
"Key" => String.t() | atom(),
"Value" => String.t() | atom()
}
"""
@type tag() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_web_acl_response() :: %{
"ChangeToken" => String.t() | atom(),
"WebACL" => web_acl()
}
"""
@type create_web_acl_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_sql_injection_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("SqlInjectionMatchSetId") => String.t() | atom(),
required("Updates") => list(sql_injection_match_set_update())
}
"""
@type update_sql_injection_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_web_acl_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type update_web_acl_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_xss_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("Updates") => list(xss_match_set_update()),
required("XssMatchSetId") => String.t() | atom()
}
"""
@type update_xss_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_logging_configuration_response() :: %{
"LoggingConfiguration" => logging_configuration()
}
"""
@type get_logging_configuration_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_regex_match_sets_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_regex_match_sets_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_rate_based_rule_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("RateLimit") => float(),
required("RuleId") => String.t() | atom(),
required("Updates") => list(rule_update())
}
"""
@type update_rate_based_rule_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_regex_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("Name") => String.t() | atom()
}
"""
@type create_regex_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
geo_match_set_summary() :: %{
"GeoMatchSetId" => String.t() | atom(),
"Name" => String.t() | atom()
}
"""
@type geo_match_set_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_geo_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("Name") => String.t() | atom()
}
"""
@type create_geo_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
ip_set() :: %{
"IPSetDescriptors" => list(ip_set_descriptor()),
"IPSetId" => String.t() | atom(),
"Name" => String.t() | atom()
}
"""
@type ip_set() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_invalid_account_exception() :: %{}
"""
@type w_a_f_invalid_account_exception() :: %{}
@typedoc """
## Example:
get_change_token_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type get_change_token_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_web_acl_request() :: %{
required("ResourceArn") => String.t() | atom()
}
"""
@type disassociate_web_acl_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_tag_operation_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_tag_operation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"NextMarker" => String.t() | atom(),
"TagInfoForResource" => tag_info_for_resource()
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_xss_match_set_response() :: %{
"ChangeToken" => String.t() | atom(),
"XssMatchSet" => xss_match_set()
}
"""
@type create_xss_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rule_group_update() :: %{
"Action" => list(any()),
"ActivatedRule" => activated_rule()
}
"""
@type rule_group_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sampled_h_t_t_p_request() :: %{
"Action" => String.t() | atom(),
"Request" => h_t_t_p_request(),
"RuleWithinRuleGroup" => String.t() | atom(),
"Timestamp" => non_neg_integer(),
"Weight" => float()
}
"""
@type sampled_h_t_t_p_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_web_acl_request() :: %{
optional("DefaultAction") => waf_action(),
optional("Updates") => list(web_acl_update()),
required("ChangeToken") => String.t() | atom(),
required("WebACLId") => String.t() | atom()
}
"""
@type update_web_acl_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_web_acl_for_resource_response() :: %{
"WebACLSummary" => web_acl_summary()
}
"""
@type get_web_acl_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_byte_match_sets_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_byte_match_sets_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_rate_based_rule_managed_keys_response() :: %{
"ManagedKeys" => list(String.t() | atom()),
"NextMarker" => String.t() | atom()
}
"""
@type get_rate_based_rule_managed_keys_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_invalid_parameter_exception() :: %{
"field" => list(any()),
"parameter" => String.t() | atom(),
"reason" => list(any())
}
"""
@type w_a_f_invalid_parameter_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_geo_match_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type update_geo_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_entity_migration_exception() :: %{
"MigrationErrorReason" => String.t() | atom(),
"MigrationErrorType" => list(any()),
"message" => String.t() | atom()
}
"""
@type w_a_f_entity_migration_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_change_token_request() :: %{}
"""
@type get_change_token_request() :: %{}
@typedoc """
## Example:
get_rule_response() :: %{
"Rule" => rule()
}
"""
@type get_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_sql_injection_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("Name") => String.t() | atom()
}
"""
@type create_sql_injection_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_rule_response() :: %{
"ChangeToken" => String.t() | atom(),
"Rule" => rule()
}
"""
@type create_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_regex_pattern_sets_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_regex_pattern_sets_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_xss_match_sets_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_xss_match_sets_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
byte_match_set_summary() :: %{
"ByteMatchSetId" => String.t() | atom(),
"Name" => String.t() | atom()
}
"""
@type byte_match_set_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
waf_override_action() :: %{
"Type" => list(any())
}
"""
@type waf_override_action() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_subscribed_rule_groups_response() :: %{
"NextMarker" => String.t() | atom(),
"RuleGroups" => list(subscribed_rule_group_summary())
}
"""
@type list_subscribed_rule_groups_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rule() :: %{
"MetricName" => String.t() | atom(),
"Name" => String.t() | atom(),
"Predicates" => list(predicate()),
"RuleId" => String.t() | atom()
}
"""
@type rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_regex_pattern_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type delete_regex_pattern_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
size_constraint_set() :: %{
"Name" => String.t() | atom(),
"SizeConstraintSetId" => String.t() | atom(),
"SizeConstraints" => list(size_constraint())
}
"""
@type size_constraint_set() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_logging_configuration_request() :: %{
required("ResourceArn") => String.t() | atom()
}
"""
@type get_logging_configuration_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_regex_pattern_set_response() :: %{
"RegexPatternSet" => regex_pattern_set()
}
"""
@type get_regex_pattern_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
geo_match_constraint() :: %{
"Type" => list(any()),
"Value" => list(any())
}
"""
@type geo_match_constraint() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
regex_pattern_set_summary() :: %{
"Name" => String.t() | atom(),
"RegexPatternSetId" => String.t() | atom()
}
"""
@type regex_pattern_set_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_permission_policy_request() :: %{
required("Policy") => String.t() | atom(),
required("ResourceArn") => String.t() | atom()
}
"""
@type put_permission_policy_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_regex_match_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type delete_regex_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_byte_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("Name") => String.t() | atom()
}
"""
@type create_byte_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_sql_injection_match_sets_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_sql_injection_match_sets_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_invalid_operation_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_invalid_operation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rule_summary() :: %{
"Name" => String.t() | atom(),
"RuleId" => String.t() | atom()
}
"""
@type rule_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
regex_match_set_summary() :: %{
"Name" => String.t() | atom(),
"RegexMatchSetId" => String.t() | atom()
}
"""
@type regex_match_set_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_change_token_status_response() :: %{
"ChangeTokenStatus" => list(any())
}
"""
@type get_change_token_status_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_activated_rules_in_rule_group_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom(),
optional("RuleGroupId") => String.t() | atom()
}
"""
@type list_activated_rules_in_rule_group_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_disallowed_name_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_disallowed_name_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_byte_match_sets_response() :: %{
"ByteMatchSets" => list(byte_match_set_summary()),
"NextMarker" => String.t() | atom()
}
"""
@type list_byte_match_sets_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_logging_configurations_response() :: %{
"LoggingConfigurations" => list(logging_configuration()),
"NextMarker" => String.t() | atom()
}
"""
@type list_logging_configurations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
h_t_t_p_header() :: %{
"Name" => String.t() | atom(),
"Value" => String.t() | atom()
}
"""
@type h_t_t_p_header() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_size_constraint_set_request() :: %{
required("SizeConstraintSetId") => String.t() | atom()
}
"""
@type get_size_constraint_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_permission_policy_response() :: %{
"Policy" => String.t() | atom()
}
"""
@type get_permission_policy_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_geo_match_sets_response() :: %{
"GeoMatchSets" => list(geo_match_set_summary()),
"NextMarker" => String.t() | atom()
}
"""
@type list_geo_match_sets_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_xss_match_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type update_xss_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
excluded_rule() :: %{
"RuleId" => String.t() | atom()
}
"""
@type excluded_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_web_acl_request() :: %{
optional("Tags") => list(tag()),
required("ChangeToken") => String.t() | atom(),
required("DefaultAction") => waf_action(),
required("MetricName") => String.t() | atom(),
required("Name") => String.t() | atom()
}
"""
@type create_web_acl_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_ip_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("Name") => String.t() | atom()
}
"""
@type create_ip_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
size_constraint_set_update() :: %{
"Action" => list(any()),
"SizeConstraint" => size_constraint()
}
"""
@type size_constraint_set_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_rule_group_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("RuleGroupId") => String.t() | atom(),
required("Updates") => list(rule_group_update())
}
"""
@type update_rule_group_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_rules_response() :: %{
"NextMarker" => String.t() | atom(),
"Rules" => list(rule_summary())
}
"""
@type list_rules_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_ip_set_response() :: %{
"IPSet" => ip_set()
}
"""
@type get_ip_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_rule_group_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type delete_rule_group_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
h_t_t_p_request() :: %{
"ClientIP" => String.t() | atom(),
"Country" => String.t() | atom(),
"HTTPVersion" => String.t() | atom(),
"Headers" => list(h_t_t_p_header()),
"Method" => String.t() | atom(),
"URI" => String.t() | atom()
}
"""
@type h_t_t_p_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
regex_pattern_set() :: %{
"Name" => String.t() | atom(),
"RegexPatternSetId" => String.t() | atom(),
"RegexPatternStrings" => list(String.t() | atom())
}
"""
@type regex_pattern_set() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_size_constraint_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type update_size_constraint_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_byte_match_set_request() :: %{
required("ByteMatchSetId") => String.t() | atom()
}
"""
@type get_byte_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_rate_based_rules_response() :: %{
"NextMarker" => String.t() | atom(),
"Rules" => list(rule_summary())
}
"""
@type list_rate_based_rules_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rule_group_summary() :: %{
"Name" => String.t() | atom(),
"RuleGroupId" => String.t() | atom()
}
"""
@type rule_group_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
ip_set_summary() :: %{
"IPSetId" => String.t() | atom(),
"Name" => String.t() | atom()
}
"""
@type ip_set_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_regex_pattern_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("Name") => String.t() | atom()
}
"""
@type create_regex_pattern_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom(),
required("ResourceARN") => String.t() | atom()
}
"""
@type list_tags_for_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_non_empty_entity_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_non_empty_entity_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_permission_policy_request() :: %{
required("ResourceArn") => String.t() | atom()
}
"""
@type delete_permission_policy_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
xss_match_set_summary() :: %{
"Name" => String.t() | atom(),
"XssMatchSetId" => String.t() | atom()
}
"""
@type xss_match_set_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_regex_match_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type update_regex_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_regex_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("RegexMatchSetId") => String.t() | atom(),
required("Updates") => list(regex_match_set_update())
}
"""
@type update_regex_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_permission_policy_request() :: %{
required("ResourceArn") => String.t() | atom()
}
"""
@type get_permission_policy_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
web_acl_update() :: %{
"Action" => list(any()),
"ActivatedRule" => activated_rule()
}
"""
@type web_acl_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
xss_match_tuple() :: %{
"FieldToMatch" => field_to_match(),
"TextTransformation" => list(any())
}
"""
@type xss_match_tuple() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
predicate() :: %{
"DataId" => String.t() | atom(),
"Negated" => boolean(),
"Type" => list(any())
}
"""
@type predicate() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_resources_for_web_acl_response() :: %{
"ResourceArns" => list(String.t() | atom())
}
"""
@type list_resources_for_web_acl_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_logging_configurations_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_logging_configurations_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_logging_configuration_response() :: %{}
"""
@type delete_logging_configuration_response() :: %{}
@typedoc """
## Example:
get_ip_set_request() :: %{
required("IPSetId") => String.t() | atom()
}
"""
@type get_ip_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_size_constraint_set_response() :: %{
"ChangeToken" => String.t() | atom(),
"SizeConstraintSet" => size_constraint_set()
}
"""
@type create_size_constraint_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_web_acl_response() :: %{}
"""
@type disassociate_web_acl_response() :: %{}
@typedoc """
## Example:
put_logging_configuration_request() :: %{
required("LoggingConfiguration") => logging_configuration()
}
"""
@type put_logging_configuration_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_permission_policy_response() :: %{}
"""
@type put_permission_policy_response() :: %{}
@typedoc """
## Example:
regex_match_tuple() :: %{
"FieldToMatch" => field_to_match(),
"RegexPatternSetId" => String.t() | atom(),
"TextTransformation" => list(any())
}
"""
@type regex_match_tuple() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_geo_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("GeoMatchSetId") => String.t() | atom(),
required("Updates") => list(geo_match_set_update())
}
"""
@type update_geo_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_change_token_status_request() :: %{
required("ChangeToken") => String.t() | atom()
}
"""
@type get_change_token_status_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rule_update() :: %{
"Action" => list(any()),
"Predicate" => predicate()
}
"""
@type rule_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_size_constraint_sets_response() :: %{
"NextMarker" => String.t() | atom(),
"SizeConstraintSets" => list(size_constraint_set_summary())
}
"""
@type list_size_constraint_sets_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
geo_match_set() :: %{
"GeoMatchConstraints" => list(geo_match_constraint()),
"GeoMatchSetId" => String.t() | atom(),
"Name" => String.t() | atom()
}
"""
@type geo_match_set() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_logging_configuration_request() :: %{
required("ResourceArn") => String.t() | atom()
}
"""
@type delete_logging_configuration_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_rate_based_rule_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type delete_rate_based_rule_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_sampled_requests_response() :: %{
"PopulationSize" => float(),
"SampledRequests" => list(sampled_h_t_t_p_request()),
"TimeWindow" => time_window()
}
"""
@type get_sampled_requests_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_regex_pattern_sets_response() :: %{
"NextMarker" => String.t() | atom(),
"RegexPatternSets" => list(regex_pattern_set_summary())
}
"""
@type list_regex_pattern_sets_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sql_injection_match_set_update() :: %{
"Action" => list(any()),
"SqlInjectionMatchTuple" => sql_injection_match_tuple()
}
"""
@type sql_injection_match_set_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_web_acls_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_web_acls_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_web_acl_migration_stack_request() :: %{
required("IgnoreUnsupportedType") => boolean(),
required("S3BucketName") => String.t() | atom(),
required("WebACLId") => String.t() | atom()
}
"""
@type create_web_acl_migration_stack_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
ip_set_descriptor() :: %{
"Type" => list(any()),
"Value" => String.t() | atom()
}
"""
@type ip_set_descriptor() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_web_acls_response() :: %{
"NextMarker" => String.t() | atom(),
"WebACLs" => list(web_acl_summary())
}
"""
@type list_web_acls_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_web_acl_migration_stack_response() :: %{
"S3ObjectUrl" => String.t() | atom()
}
"""
@type create_web_acl_migration_stack_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_ip_set_response() :: %{
"ChangeToken" => String.t() | atom(),
"IPSet" => ip_set()
}
"""
@type create_ip_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_sql_injection_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("SqlInjectionMatchSetId") => String.t() | atom()
}
"""
@type delete_sql_injection_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_regex_pattern_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type update_regex_pattern_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
ip_set_update() :: %{
"Action" => list(any()),
"IPSetDescriptor" => ip_set_descriptor()
}
"""
@type ip_set_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_size_constraint_sets_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_size_constraint_sets_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_web_acl_request() :: %{
required("WebACLId") => String.t() | atom()
}
"""
@type get_web_acl_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sql_injection_match_tuple() :: %{
"FieldToMatch" => field_to_match(),
"TextTransformation" => list(any())
}
"""
@type sql_injection_match_tuple() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_regex_match_set_response() :: %{
"RegexMatchSet" => regex_match_set()
}
"""
@type get_regex_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_web_acl_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type delete_web_acl_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_subscription_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_subscription_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_rule_group_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("RuleGroupId") => String.t() | atom()
}
"""
@type delete_rule_group_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_limits_exceeded_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_limits_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_rate_based_rule_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("RuleId") => String.t() | atom()
}
"""
@type delete_rate_based_rule_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_web_acl_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("WebACLId") => String.t() | atom()
}
"""
@type delete_web_acl_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_geo_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("GeoMatchSetId") => String.t() | atom()
}
"""
@type delete_geo_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
w_a_f_tag_operation_internal_error_exception() :: %{
"message" => String.t() | atom()
}
"""
@type w_a_f_tag_operation_internal_error_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_sql_injection_match_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type delete_sql_injection_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
web_acl_summary() :: %{
"Name" => String.t() | atom(),
"WebACLId" => String.t() | atom()
}
"""
@type web_acl_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_size_constraint_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type delete_size_constraint_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_rate_based_rule_request() :: %{
optional("Tags") => list(tag()),
required("ChangeToken") => String.t() | atom(),
required("MetricName") => String.t() | atom(),
required("Name") => String.t() | atom(),
required("RateKey") => list(any()),
required("RateLimit") => float()
}
"""
@type create_rate_based_rule_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_rule_groups_request() :: %{
optional("Limit") => integer(),
optional("NextMarker") => String.t() | atom()
}
"""
@type list_rule_groups_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
byte_match_set() :: %{
"ByteMatchSetId" => String.t() | atom(),
"ByteMatchTuples" => list(byte_match_tuple()),
"Name" => String.t() | atom()
}
"""
@type byte_match_set() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_ip_set_response() :: %{
"ChangeToken" => String.t() | atom()
}
"""
@type delete_ip_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
size_constraint_set_summary() :: %{
"Name" => String.t() | atom(),
"SizeConstraintSetId" => String.t() | atom()
}
"""
@type size_constraint_set_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_regex_match_set_response() :: %{
"ChangeToken" => String.t() | atom(),
"RegexMatchSet" => regex_match_set()
}
"""
@type create_regex_match_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_xss_match_set_request() :: %{
required("ChangeToken") => String.t() | atom(),
required("Name") => String.t() | atom()
}
"""
@type create_xss_match_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_regex_pattern_set_response() :: %{
"ChangeToken" => String.t() | atom(),
"RegexPatternSet" => regex_pattern_set()
}
"""
@type create_regex_pattern_set_response() :: %{(String.t() | atom()) => any()}
@type associate_web_acl_errors() ::
w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_unavailable_entity_exception()
| w_a_f_nonexistent_item_exception()
@type create_byte_match_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
@type create_geo_match_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
@type create_ip_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
@type create_rate_based_rule_errors() ::
w_a_f_tag_operation_internal_error_exception()
| w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_tag_operation_exception()
| w_a_f_internal_error_exception()
| w_a_f_bad_request_exception()
| w_a_f_stale_data_exception()
@type create_regex_match_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
@type create_regex_pattern_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
@type create_rule_errors() ::
w_a_f_tag_operation_internal_error_exception()
| w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_tag_operation_exception()
| w_a_f_internal_error_exception()
| w_a_f_bad_request_exception()
| w_a_f_stale_data_exception()
@type create_rule_group_errors() ::
w_a_f_tag_operation_internal_error_exception()
| w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_tag_operation_exception()
| w_a_f_internal_error_exception()
| w_a_f_bad_request_exception()
| w_a_f_stale_data_exception()
@type create_size_constraint_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
@type create_sql_injection_match_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
@type create_web_acl_errors() ::
w_a_f_tag_operation_internal_error_exception()
| w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_tag_operation_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_bad_request_exception()
| w_a_f_stale_data_exception()
@type create_web_acl_migration_stack_errors() ::
w_a_f_invalid_operation_exception()
| w_a_f_entity_migration_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type create_xss_match_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
@type delete_byte_match_set_errors() ::
w_a_f_non_empty_entity_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_geo_match_set_errors() ::
w_a_f_non_empty_entity_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_ip_set_errors() ::
w_a_f_non_empty_entity_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_logging_configuration_errors() ::
w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_permission_policy_errors() ::
w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_rate_based_rule_errors() ::
w_a_f_tag_operation_internal_error_exception()
| w_a_f_non_empty_entity_exception()
| w_a_f_tag_operation_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_regex_match_set_errors() ::
w_a_f_non_empty_entity_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_regex_pattern_set_errors() ::
w_a_f_non_empty_entity_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_rule_errors() ::
w_a_f_tag_operation_internal_error_exception()
| w_a_f_non_empty_entity_exception()
| w_a_f_tag_operation_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_rule_group_errors() ::
w_a_f_tag_operation_internal_error_exception()
| w_a_f_non_empty_entity_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_tag_operation_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_size_constraint_set_errors() ::
w_a_f_non_empty_entity_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_sql_injection_match_set_errors() ::
w_a_f_non_empty_entity_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_web_acl_errors() ::
w_a_f_tag_operation_internal_error_exception()
| w_a_f_non_empty_entity_exception()
| w_a_f_tag_operation_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type delete_xss_match_set_errors() ::
w_a_f_non_empty_entity_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type disassociate_web_acl_errors() ::
w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type get_byte_match_set_errors() ::
w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type get_change_token_errors() :: w_a_f_internal_error_exception()
@type get_change_token_status_errors() ::
w_a_f_internal_error_exception() | w_a_f_nonexistent_item_exception()
@type get_geo_match_set_errors() ::
w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type get_ip_set_errors() ::
w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type get_logging_configuration_errors() ::
w_a_f_internal_error_exception() | w_a_f_nonexistent_item_exception()
@type get_permission_policy_errors() ::
w_a_f_internal_error_exception() | w_a_f_nonexistent_item_exception()
@type get_rate_based_rule_errors() ::
w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type get_rate_based_rule_managed_keys_errors() ::
w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type get_regex_match_set_errors() ::
w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type get_regex_pattern_set_errors() ::
w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type get_rule_errors() ::
w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type get_rule_group_errors() ::
w_a_f_internal_error_exception() | w_a_f_nonexistent_item_exception()
@type get_sampled_requests_errors() ::
w_a_f_internal_error_exception() | w_a_f_nonexistent_item_exception()
@type get_size_constraint_set_errors() ::
w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type get_sql_injection_match_set_errors() ::
w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type get_web_acl_errors() ::
w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type get_web_acl_for_resource_errors() ::
w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_unavailable_entity_exception()
| w_a_f_nonexistent_item_exception()
@type get_xss_match_set_errors() ::
w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type list_activated_rules_in_rule_group_errors() ::
w_a_f_invalid_parameter_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type list_byte_match_sets_errors() ::
w_a_f_invalid_account_exception() | w_a_f_internal_error_exception()
@type list_geo_match_sets_errors() ::
w_a_f_invalid_account_exception() | w_a_f_internal_error_exception()
@type list_ip_sets_errors() ::
w_a_f_invalid_account_exception() | w_a_f_internal_error_exception()
@type list_logging_configurations_errors() ::
w_a_f_invalid_parameter_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type list_rate_based_rules_errors() ::
w_a_f_invalid_account_exception() | w_a_f_internal_error_exception()
@type list_regex_match_sets_errors() ::
w_a_f_invalid_account_exception() | w_a_f_internal_error_exception()
@type list_regex_pattern_sets_errors() ::
w_a_f_invalid_account_exception() | w_a_f_internal_error_exception()
@type list_resources_for_web_acl_errors() ::
w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_item_exception()
@type list_rule_groups_errors() :: w_a_f_internal_error_exception()
@type list_rules_errors() ::
w_a_f_invalid_account_exception() | w_a_f_internal_error_exception()
@type list_size_constraint_sets_errors() ::
w_a_f_invalid_account_exception() | w_a_f_internal_error_exception()
@type list_sql_injection_match_sets_errors() ::
w_a_f_invalid_account_exception() | w_a_f_internal_error_exception()
@type list_subscribed_rule_groups_errors() ::
w_a_f_internal_error_exception() | w_a_f_nonexistent_item_exception()
@type list_tags_for_resource_errors() ::
w_a_f_tag_operation_internal_error_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_tag_operation_exception()
| w_a_f_internal_error_exception()
| w_a_f_bad_request_exception()
| w_a_f_nonexistent_item_exception()
@type list_web_acls_errors() ::
w_a_f_invalid_account_exception() | w_a_f_internal_error_exception()
@type list_xss_match_sets_errors() ::
w_a_f_invalid_account_exception() | w_a_f_internal_error_exception()
@type put_logging_configuration_errors() ::
w_a_f_internal_error_exception()
| w_a_f_service_linked_role_error_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type put_permission_policy_errors() ::
w_a_f_internal_error_exception()
| w_a_f_invalid_permission_policy_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type tag_resource_errors() ::
w_a_f_tag_operation_internal_error_exception()
| w_a_f_limits_exceeded_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_tag_operation_exception()
| w_a_f_internal_error_exception()
| w_a_f_bad_request_exception()
| w_a_f_nonexistent_item_exception()
@type untag_resource_errors() ::
w_a_f_tag_operation_internal_error_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_tag_operation_exception()
| w_a_f_internal_error_exception()
| w_a_f_bad_request_exception()
| w_a_f_nonexistent_item_exception()
@type update_byte_match_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_container_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type update_geo_match_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_container_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type update_ip_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_container_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type update_rate_based_rule_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_container_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type update_regex_match_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_disallowed_name_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_container_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type update_regex_pattern_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_container_exception()
| w_a_f_stale_data_exception()
| w_a_f_invalid_regex_pattern_exception()
| w_a_f_nonexistent_item_exception()
@type update_rule_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_container_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type update_rule_group_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_container_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type update_size_constraint_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_container_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type update_sql_injection_match_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_container_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type update_web_acl_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_subscription_not_found_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_referenced_item_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_container_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
@type update_xss_match_set_errors() ::
w_a_f_limits_exceeded_exception()
| w_a_f_invalid_operation_exception()
| w_a_f_invalid_parameter_exception()
| w_a_f_invalid_account_exception()
| w_a_f_internal_error_exception()
| w_a_f_nonexistent_container_exception()
| w_a_f_stale_data_exception()
| w_a_f_nonexistent_item_exception()
def metadata do
%{
api_version: "2016-11-28",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "waf-regional",
global?: false,
hostname: nil,
protocol: "json",
service_id: "WAF Regional",
signature_version: "v4",
signing_name: "waf-regional",
target_prefix: "AWSWAF_Regional_20161128"
}
end
@doc """
This is **AWS WAF Classic Regional** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Associates a web ACL with a resource, either an application load balancer or
Amazon API Gateway stage.
"""
@spec associate_web_acl(map(), associate_web_acl_request(), list()) ::
{:ok, associate_web_acl_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_web_acl_errors()}
def associate_web_acl(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AssociateWebACL", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Creates a `ByteMatchSet`. You then use `UpdateByteMatchSet` to identify the part
of a
web request that you want AWS WAF to inspect, such as the values of the
`User-Agent` header or the query string.
For example, you can create a `ByteMatchSet` that matches any requests with
`User-Agent` headers
that contain the string `BadBot`. You can then configure AWS WAF to reject those
requests.
To create and configure a `ByteMatchSet`, perform the following steps:
1.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`CreateByteMatchSet` request.
2.
Submit a `CreateByteMatchSet` request.
3.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateByteMatchSet` request.
4.
Submit an `UpdateByteMatchSet` request to specify the part of the request that
you want AWS WAF to inspect
(for example, the header or the URI) and the value that you want AWS WAF to
watch for.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec create_byte_match_set(map(), create_byte_match_set_request(), list()) ::
{:ok, create_byte_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_byte_match_set_errors()}
def create_byte_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateByteMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Creates an `GeoMatchSet`, which you use to specify which web requests you want
to allow or block based on the country
that the requests originate from. For example, if you're receiving a lot of
requests from one or more countries and you want to block the requests, you can
create an `GeoMatchSet` that contains those countries and then configure AWS WAF
to block the requests.
To create and configure a `GeoMatchSet`, perform the following steps:
1.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`CreateGeoMatchSet` request.
2.
Submit a `CreateGeoMatchSet` request.
3.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateGeoMatchSet` request.
4.
Submit an `UpdateGeoMatchSetSet` request to specify the countries that you want
AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec create_geo_match_set(map(), create_geo_match_set_request(), list()) ::
{:ok, create_geo_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_geo_match_set_errors()}
def create_geo_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateGeoMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Creates an `IPSet`, which you use to specify which web requests
that
you want to allow or block based on the IP addresses that the requests
originate from. For example, if you're receiving a lot of requests from one or
more
individual IP addresses or one or more ranges of IP addresses and you want to
block the
requests, you can create an `IPSet` that contains those IP addresses and then
configure AWS WAF to block the requests.
To create and configure an `IPSet`, perform the following steps:
1.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`CreateIPSet` request.
2.
Submit a `CreateIPSet` request.
3.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateIPSet` request.
4.
Submit an `UpdateIPSet` request to specify the IP addresses that you want AWS
WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec create_ip_set(map(), create_ip_set_request(), list()) ::
{:ok, create_ip_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_ip_set_errors()}
def create_ip_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateIPSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Creates a `RateBasedRule`. The `RateBasedRule` contains a
`RateLimit`, which specifies the maximum number of requests that AWS WAF allows
from a specified IP address in a five-minute period.
The `RateBasedRule` also
contains the `IPSet` objects, `ByteMatchSet` objects, and other
predicates that identify the requests that you want to count or block if these
requests
exceed the `RateLimit`.
If you add more than one predicate to a `RateBasedRule`, a request not
only must exceed the `RateLimit`, but it also must match all the
conditions to be counted or blocked. For example, suppose you add the following
to a
`RateBasedRule`:
*
An `IPSet` that matches the IP address `192.0.2.44/32`
*
A `ByteMatchSet` that matches `BadBot` in the
`User-Agent` header
Further, you specify a `RateLimit` of 1,000.
You then add the `RateBasedRule` to a `WebACL` and specify that
you want to block requests that meet the conditions in the rule. For a request
to be
blocked, it must come from the IP address 192.0.2.44 *and* the
`User-Agent` header in the request must contain the value
`BadBot`. Further, requests that match these two conditions must be received at
a rate of more than 1,000 requests every five minutes. If both conditions are
met and the
rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for
a
five-minute period, AWS WAF no longer blocks the requests.
As a second example, suppose you want to limit requests to a particular page on
your site. To do this, you could add the following to a
`RateBasedRule`:
*
A `ByteMatchSet` with `FieldToMatch` of `URI`
*
A `PositionalConstraint` of `STARTS_WITH`
*
A `TargetString` of `login`
Further, you specify a `RateLimit` of 1,000.
By adding this `RateBasedRule` to a `WebACL`, you could limit requests to your
login page without affecting the rest of your site.
To create and configure a `RateBasedRule`, perform the following
steps:
1.
Create and update the predicates that you want to include in the rule. For more
information, see `CreateByteMatchSet`, `CreateIPSet`,
and `CreateSqlInjectionMatchSet`.
2.
Use `GetChangeToken` to get the change token that you provide
in the `ChangeToken` parameter of a `CreateRule`
request.
3.
Submit a `CreateRateBasedRule` request.
4.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an `UpdateRule`
request.
5.
Submit an `UpdateRateBasedRule` request to specify the predicates
that you want to include in the rule.
6.
Create and update a `WebACL` that contains the
`RateBasedRule`. For more information, see `CreateWebACL`.
For more information about how to use the AWS WAF API to allow or block HTTP
requests,
see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec create_rate_based_rule(map(), create_rate_based_rule_request(), list()) ::
{:ok, create_rate_based_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_rate_based_rule_errors()}
def create_rate_based_rule(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateRateBasedRule", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Creates a `RegexMatchSet`. You then use `UpdateRegexMatchSet` to identify the
part of a
web request that you want AWS WAF to inspect, such as the values of the
`User-Agent` header or the query string.
For example, you can create a `RegexMatchSet` that contains a `RegexMatchTuple`
that looks for any requests with `User-Agent` headers
that match a `RegexPatternSet` with pattern `B[a@]dB[o0]t`. You can then configure AWS WAF to reject those requests.
To create and configure a `RegexMatchSet`, perform the following steps:
1.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`CreateRegexMatchSet` request.
2.
Submit a `CreateRegexMatchSet` request.
3.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateRegexMatchSet` request.
4.
Submit an `UpdateRegexMatchSet` request to specify the part of the request that
you want AWS WAF to inspect
(for example, the header or the URI) and the value, using a `RegexPatternSet`,
that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer
Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec create_regex_match_set(map(), create_regex_match_set_request(), list()) ::
{:ok, create_regex_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_regex_match_set_errors()}
def create_regex_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateRegexMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Creates a `RegexPatternSet`. You then use `UpdateRegexPatternSet` to specify the
regular expression (regex) pattern that you want AWS WAF to search for, such as
`B[a@]dB[o0]t`. You can then configure AWS WAF to reject those requests. To create and configure a `RegexPatternSet`, perform the following steps:
1.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`CreateRegexPatternSet` request.
2.
Submit a `CreateRegexPatternSet` request.
3.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateRegexPatternSet` request.
4.
Submit an `UpdateRegexPatternSet` request to specify the string that you want
AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer
Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec create_regex_pattern_set(map(), create_regex_pattern_set_request(), list()) ::
{:ok, create_regex_pattern_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_regex_pattern_set_errors()}
def create_regex_pattern_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateRegexPatternSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Creates a `Rule`, which contains the `IPSet` objects,
`ByteMatchSet` objects, and other predicates that identify the requests that
you want to block. If you add more than one predicate to a `Rule`, a request
must match all of the specifications to be allowed or blocked. For example,
suppose
that
you add the following to a `Rule`:
*
An `IPSet` that matches the IP address `192.0.2.44/32`
*
A `ByteMatchSet` that matches `BadBot` in the `User-Agent` header
You then add the `Rule` to a `WebACL` and specify that you want to blocks
requests that satisfy the `Rule`.
For a request to be blocked, it must come from the IP address 192.0.2.44 *and*
the `User-Agent` header in the request
must contain the value `BadBot`.
To create and configure a `Rule`, perform the following steps:
1.
Create and update the predicates that you want to include in the `Rule`. For
more information, see
`CreateByteMatchSet`, `CreateIPSet`, and `CreateSqlInjectionMatchSet`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`CreateRule` request.
3.
Submit a `CreateRule` request.
4.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateRule` request.
5.
Submit an `UpdateRule` request to specify the predicates that you want to
include in the `Rule`.
6.
Create and update a `WebACL` that contains the `Rule`. For more information, see
`CreateWebACL`.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec create_rule(map(), create_rule_request(), list()) ::
{:ok, create_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_rule_errors()}
def create_rule(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateRule", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Creates a `RuleGroup`. A rule group is a collection of predefined rules that you
add to a web ACL. You use `UpdateRuleGroup` to add rules to the rule group.
Rule groups are subject to the following limits:
*
Three rule groups per account. You can request an increase to this limit by
contacting customer support.
*
One rule group per web ACL.
*
Ten rules per rule group.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec create_rule_group(map(), create_rule_group_request(), list()) ::
{:ok, create_rule_group_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_rule_group_errors()}
def create_rule_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateRuleGroup", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Creates a `SizeConstraintSet`. You then use `UpdateSizeConstraintSet` to
identify the part of a
web request that you want AWS WAF to check for length, such as the length of the
`User-Agent` header or the length of the query string.
For example, you can create a `SizeConstraintSet` that matches any requests that
have a query string that is longer than 100 bytes.
You can then configure AWS WAF to reject those requests.
To create and configure a `SizeConstraintSet`, perform the following steps:
1.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`CreateSizeConstraintSet` request.
2.
Submit a `CreateSizeConstraintSet` request.
3.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateSizeConstraintSet` request.
4.
Submit an `UpdateSizeConstraintSet` request to specify the part of the request
that you want AWS WAF to inspect
(for example, the header or the URI) and the value that you want AWS WAF to
watch for.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec create_size_constraint_set(map(), create_size_constraint_set_request(), list()) ::
{:ok, create_size_constraint_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_size_constraint_set_errors()}
def create_size_constraint_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateSizeConstraintSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Creates a `SqlInjectionMatchSet`, which you use to allow, block, or count
requests that contain snippets of SQL code in a
specified part of web requests. AWS WAF searches for character sequences that
are likely to be malicious strings.
To create and configure a `SqlInjectionMatchSet`, perform the following steps:
1.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`CreateSqlInjectionMatchSet` request.
2.
Submit a `CreateSqlInjectionMatchSet` request.
3.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateSqlInjectionMatchSet` request.
4.
Submit an `UpdateSqlInjectionMatchSet` request to specify the parts of web
requests in which you want to
allow, block, or count malicious SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec create_sql_injection_match_set(map(), create_sql_injection_match_set_request(), list()) ::
{:ok, create_sql_injection_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_sql_injection_match_set_errors()}
def create_sql_injection_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateSqlInjectionMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Creates a `WebACL`, which contains the `Rules` that identify the CloudFront web
requests that you want to allow, block, or count.
AWS WAF evaluates `Rules` in order based on the value of `Priority` for each
`Rule`.
You also specify a default action, either `ALLOW` or `BLOCK`. If a web request
doesn't match
any of the `Rules` in a `WebACL`, AWS WAF responds to the request with the
default action.
To create and configure a `WebACL`, perform the following steps:
1.
Create and update the `ByteMatchSet` objects and other predicates that you want
to include in `Rules`.
For more information, see `CreateByteMatchSet`, `UpdateByteMatchSet`,
`CreateIPSet`, `UpdateIPSet`,
`CreateSqlInjectionMatchSet`, and `UpdateSqlInjectionMatchSet`.
2.
Create and update the `Rules` that you want to include in the `WebACL`. For more
information, see
`CreateRule` and `UpdateRule`.
3.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`CreateWebACL` request.
4.
Submit a `CreateWebACL` request.
5.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateWebACL` request.
6.
Submit an `UpdateWebACL` request to specify the `Rules` that you want to include
in the `WebACL`,
to specify the default action, and to associate the `WebACL` with a CloudFront
distribution.
For more information about how to use the AWS WAF API, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec create_web_acl(map(), create_web_acl_request(), list()) ::
{:ok, create_web_acl_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_web_acl_errors()}
def create_web_acl(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateWebACL", input, options)
end
@doc """
Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the
specified Amazon S3 bucket.
Then, in CloudFormation, you create a stack from the template, to create the web
ACL and its resources in AWS WAFV2.
Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS
WAF.
This is part of a larger migration procedure for web ACLs from AWS WAF Classic
to the latest version of AWS WAF.
For the full procedure, including caveats and manual steps to complete
the migration and switch over to the new web ACL, see
[Migrating your AWS WAF Classic resources to AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-migrating-from-classic.html)
in the [AWS WAF Developer
Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
"""
@spec create_web_acl_migration_stack(map(), create_web_acl_migration_stack_request(), list()) ::
{:ok, create_web_acl_migration_stack_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_web_acl_migration_stack_errors()}
def create_web_acl_migration_stack(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateWebACLMigrationStack", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Creates an `XssMatchSet`, which you use to allow, block, or count requests that
contain cross-site scripting attacks
in the specified part of web requests. AWS WAF searches for character sequences
that are likely to be malicious strings.
To create and configure an `XssMatchSet`, perform the following steps:
1.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`CreateXssMatchSet` request.
2.
Submit a `CreateXssMatchSet` request.
3.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateXssMatchSet` request.
4.
Submit an `UpdateXssMatchSet` request to specify the parts of web requests in
which you want to
allow, block, or count cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec create_xss_match_set(map(), create_xss_match_set_request(), list()) ::
{:ok, create_xss_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_xss_match_set_errors()}
def create_xss_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateXssMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes a `ByteMatchSet`. You can't delete a `ByteMatchSet` if it's
still used in any `Rules`
or if it still includes any `ByteMatchTuple` objects (any filters).
If you just want to remove a `ByteMatchSet` from a `Rule`, use `UpdateRule`.
To permanently delete a `ByteMatchSet`, perform the following steps:
1.
Update the `ByteMatchSet` to remove filters, if any. For more information, see
`UpdateByteMatchSet`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`DeleteByteMatchSet` request.
3.
Submit a `DeleteByteMatchSet` request.
"""
@spec delete_byte_match_set(map(), delete_byte_match_set_request(), list()) ::
{:ok, delete_byte_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_byte_match_set_errors()}
def delete_byte_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteByteMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes a `GeoMatchSet`. You can't delete a `GeoMatchSet` if it's
still used in any `Rules` or
if it still includes any countries.
If you just want to remove a `GeoMatchSet` from a `Rule`, use `UpdateRule`.
To permanently delete a `GeoMatchSet` from AWS WAF, perform the following steps:
1.
Update the `GeoMatchSet` to remove any countries. For more information, see
`UpdateGeoMatchSet`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`DeleteGeoMatchSet` request.
3.
Submit a `DeleteGeoMatchSet` request.
"""
@spec delete_geo_match_set(map(), delete_geo_match_set_request(), list()) ::
{:ok, delete_geo_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_geo_match_set_errors()}
def delete_geo_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteGeoMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes an `IPSet`. You can't delete an `IPSet` if it's still used
in any `Rules` or
if it still includes any IP addresses.
If you just want to remove an `IPSet` from a `Rule`, use `UpdateRule`.
To permanently delete an `IPSet` from AWS WAF, perform the following steps:
1.
Update the `IPSet` to remove IP address ranges, if any. For more information,
see `UpdateIPSet`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`DeleteIPSet` request.
3.
Submit a `DeleteIPSet` request.
"""
@spec delete_ip_set(map(), delete_ip_set_request(), list()) ::
{:ok, delete_ip_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_ip_set_errors()}
def delete_ip_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteIPSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes the `LoggingConfiguration` from the specified web
ACL.
"""
@spec delete_logging_configuration(map(), delete_logging_configuration_request(), list()) ::
{:ok, delete_logging_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_logging_configuration_errors()}
def delete_logging_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteLoggingConfiguration", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes an IAM policy from the specified RuleGroup.
The user making the request must be the owner of the RuleGroup.
"""
@spec delete_permission_policy(map(), delete_permission_policy_request(), list()) ::
{:ok, delete_permission_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_permission_policy_errors()}
def delete_permission_policy(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeletePermissionPolicy", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes a `RateBasedRule`. You can't delete a rule if
it's still used in any `WebACL` objects or if it still includes any predicates,
such as `ByteMatchSet` objects.
If you just want to remove a rule from a `WebACL`, use `UpdateWebACL`.
To permanently delete a `RateBasedRule` from AWS WAF, perform the following
steps:
1.
Update the `RateBasedRule` to remove predicates, if any. For more
information, see `UpdateRateBasedRule`.
2.
Use `GetChangeToken` to get the change token that you provide
in the `ChangeToken` parameter of a `DeleteRateBasedRule`
request.
3.
Submit a `DeleteRateBasedRule` request.
"""
@spec delete_rate_based_rule(map(), delete_rate_based_rule_request(), list()) ::
{:ok, delete_rate_based_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_rate_based_rule_errors()}
def delete_rate_based_rule(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteRateBasedRule", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes a `RegexMatchSet`. You can't delete a `RegexMatchSet` if
it's still used in any `Rules`
or if it still includes any `RegexMatchTuples` objects (any filters).
If you just want to remove a `RegexMatchSet` from a `Rule`, use `UpdateRule`.
To permanently delete a `RegexMatchSet`, perform the following steps:
1.
Update the `RegexMatchSet` to remove filters, if any. For more information, see
`UpdateRegexMatchSet`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`DeleteRegexMatchSet` request.
3.
Submit a `DeleteRegexMatchSet` request.
"""
@spec delete_regex_match_set(map(), delete_regex_match_set_request(), list()) ::
{:ok, delete_regex_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_regex_match_set_errors()}
def delete_regex_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteRegexMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes a `RegexPatternSet`. You can't delete a `RegexPatternSet` if
it's still used in any `RegexMatchSet`
or if the `RegexPatternSet` is not empty.
"""
@spec delete_regex_pattern_set(map(), delete_regex_pattern_set_request(), list()) ::
{:ok, delete_regex_pattern_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_regex_pattern_set_errors()}
def delete_regex_pattern_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteRegexPatternSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes a `Rule`. You can't delete a `Rule` if it's still used in
any `WebACL`
objects or if it still includes any predicates, such as `ByteMatchSet` objects.
If you just want to remove a `Rule` from a `WebACL`, use `UpdateWebACL`.
To permanently delete a `Rule` from AWS WAF, perform the following steps:
1.
Update the `Rule` to remove predicates, if any. For more information, see
`UpdateRule`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`DeleteRule` request.
3.
Submit a `DeleteRule` request.
"""
@spec delete_rule(map(), delete_rule_request(), list()) ::
{:ok, delete_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_rule_errors()}
def delete_rule(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteRule", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes a `RuleGroup`. You can't delete a `RuleGroup` if it's still
used in any `WebACL`
objects or if it still includes any rules.
If you just want to remove a `RuleGroup` from a `WebACL`, use `UpdateWebACL`.
To permanently delete a `RuleGroup` from AWS WAF, perform the following steps:
1.
Update the `RuleGroup` to remove rules, if any. For more information, see
`UpdateRuleGroup`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`DeleteRuleGroup` request.
3.
Submit a `DeleteRuleGroup` request.
"""
@spec delete_rule_group(map(), delete_rule_group_request(), list()) ::
{:ok, delete_rule_group_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_rule_group_errors()}
def delete_rule_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteRuleGroup", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes a `SizeConstraintSet`. You can't delete a
`SizeConstraintSet` if it's still used in any `Rules`
or if it still includes any `SizeConstraint` objects (any filters).
If you just want to remove a `SizeConstraintSet` from a `Rule`, use
`UpdateRule`.
To permanently delete a `SizeConstraintSet`, perform the following steps:
1.
Update the `SizeConstraintSet` to remove filters, if any. For more information,
see `UpdateSizeConstraintSet`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`DeleteSizeConstraintSet` request.
3.
Submit a `DeleteSizeConstraintSet` request.
"""
@spec delete_size_constraint_set(map(), delete_size_constraint_set_request(), list()) ::
{:ok, delete_size_constraint_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_size_constraint_set_errors()}
def delete_size_constraint_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteSizeConstraintSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes a `SqlInjectionMatchSet`. You can't delete a
`SqlInjectionMatchSet` if it's
still used in any `Rules` or if it still contains any `SqlInjectionMatchTuple`
objects.
If you just want to remove a `SqlInjectionMatchSet` from a `Rule`, use
`UpdateRule`.
To permanently delete a `SqlInjectionMatchSet` from AWS WAF, perform the
following steps:
1.
Update the `SqlInjectionMatchSet` to remove filters, if any. For more
information, see
`UpdateSqlInjectionMatchSet`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`DeleteSqlInjectionMatchSet` request.
3.
Submit a `DeleteSqlInjectionMatchSet` request.
"""
@spec delete_sql_injection_match_set(map(), delete_sql_injection_match_set_request(), list()) ::
{:ok, delete_sql_injection_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_sql_injection_match_set_errors()}
def delete_sql_injection_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteSqlInjectionMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes a `WebACL`. You can't delete a `WebACL` if it still contains
any `Rules`.
To delete a `WebACL`, perform the following steps:
1.
Update the `WebACL` to remove `Rules`, if any. For more information, see
`UpdateWebACL`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`DeleteWebACL` request.
3.
Submit a `DeleteWebACL` request.
"""
@spec delete_web_acl(map(), delete_web_acl_request(), list()) ::
{:ok, delete_web_acl_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_web_acl_errors()}
def delete_web_acl(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteWebACL", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Permanently deletes an `XssMatchSet`. You can't delete an `XssMatchSet` if it's
still used in any `Rules` or if it still contains any `XssMatchTuple` objects.
If you just want to remove an `XssMatchSet` from a `Rule`, use `UpdateRule`.
To permanently delete an `XssMatchSet` from AWS WAF, perform the following
steps:
1.
Update the `XssMatchSet` to remove filters, if any. For more information, see
`UpdateXssMatchSet`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of a
`DeleteXssMatchSet` request.
3.
Submit a `DeleteXssMatchSet` request.
"""
@spec delete_xss_match_set(map(), delete_xss_match_set_request(), list()) ::
{:ok, delete_xss_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_xss_match_set_errors()}
def delete_xss_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteXssMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic Regional** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Removes a web ACL from the specified resource, either an application load
balancer or Amazon API Gateway stage.
"""
@spec disassociate_web_acl(map(), disassociate_web_acl_request(), list()) ::
{:ok, disassociate_web_acl_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_web_acl_errors()}
def disassociate_web_acl(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DisassociateWebACL", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `ByteMatchSet` specified by `ByteMatchSetId`.
"""
@spec get_byte_match_set(map(), get_byte_match_set_request(), list()) ::
{:ok, get_byte_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_byte_match_set_errors()}
def get_byte_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetByteMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
When you want to create, update, or delete AWS WAF objects, get a change token
and include the change token in the create, update, or delete request. Change
tokens ensure that your application doesn't submit conflicting requests to AWS
WAF.
Each create, update, or delete request must use a unique change token. If your
application submits a `GetChangeToken` request
and then submits a second `GetChangeToken` request before submitting a create,
update, or delete request, the second
`GetChangeToken` request returns the same value as the first `GetChangeToken`
request.
When you use a change token in a create, update, or delete request, the status
of the change token changes to `PENDING`,
which indicates that AWS WAF is propagating the change to all AWS WAF servers.
Use `GetChangeTokenStatus` to determine the
status of your change token.
"""
@spec get_change_token(map(), get_change_token_request(), list()) ::
{:ok, get_change_token_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_change_token_errors()}
def get_change_token(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetChangeToken", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the status of a `ChangeToken` that you got by calling `GetChangeToken`.
`ChangeTokenStatus` is
one of the following values:
*
`PROVISIONED`: You requested the change token by calling `GetChangeToken`, but
you haven't used it yet
in a call to create, update, or delete an AWS WAF object.
*
`PENDING`: AWS WAF is propagating the create, update, or delete request to all
AWS WAF servers.
*
`INSYNC`: Propagation is complete.
"""
@spec get_change_token_status(map(), get_change_token_status_request(), list()) ::
{:ok, get_change_token_status_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_change_token_status_errors()}
def get_change_token_status(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetChangeTokenStatus", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `GeoMatchSet` that is specified by `GeoMatchSetId`.
"""
@spec get_geo_match_set(map(), get_geo_match_set_request(), list()) ::
{:ok, get_geo_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_geo_match_set_errors()}
def get_geo_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetGeoMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `IPSet` that is specified by `IPSetId`.
"""
@spec get_ip_set(map(), get_ip_set_request(), list()) ::
{:ok, get_ip_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_ip_set_errors()}
def get_ip_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetIPSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `LoggingConfiguration` for the specified web ACL.
"""
@spec get_logging_configuration(map(), get_logging_configuration_request(), list()) ::
{:ok, get_logging_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_logging_configuration_errors()}
def get_logging_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetLoggingConfiguration", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the IAM policy attached to the RuleGroup.
"""
@spec get_permission_policy(map(), get_permission_policy_request(), list()) ::
{:ok, get_permission_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_permission_policy_errors()}
def get_permission_policy(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetPermissionPolicy", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `RateBasedRule` that is specified by the
`RuleId` that you included in the `GetRateBasedRule`
request.
"""
@spec get_rate_based_rule(map(), get_rate_based_rule_request(), list()) ::
{:ok, get_rate_based_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_rate_based_rule_errors()}
def get_rate_based_rule(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRateBasedRule", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of IP addresses currently being blocked by the `RateBasedRule`
that is specified by the `RuleId`. The maximum
number of managed keys that will be blocked is 10,000. If more than 10,000
addresses exceed
the rate limit, the 10,000 addresses with the highest rates will be blocked.
"""
@spec get_rate_based_rule_managed_keys(
map(),
get_rate_based_rule_managed_keys_request(),
list()
) ::
{:ok, get_rate_based_rule_managed_keys_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_rate_based_rule_managed_keys_errors()}
def get_rate_based_rule_managed_keys(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRateBasedRuleManagedKeys", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `RegexMatchSet` specified by `RegexMatchSetId`.
"""
@spec get_regex_match_set(map(), get_regex_match_set_request(), list()) ::
{:ok, get_regex_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_regex_match_set_errors()}
def get_regex_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRegexMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `RegexPatternSet` specified by `RegexPatternSetId`.
"""
@spec get_regex_pattern_set(map(), get_regex_pattern_set_request(), list()) ::
{:ok, get_regex_pattern_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_regex_pattern_set_errors()}
def get_regex_pattern_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRegexPatternSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `Rule` that is specified by the `RuleId` that you included in the
`GetRule` request.
"""
@spec get_rule(map(), get_rule_request(), list()) ::
{:ok, get_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_rule_errors()}
def get_rule(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRule", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `RuleGroup` that is specified by the `RuleGroupId` that you included
in the `GetRuleGroup` request.
To view the rules in a rule group, use `ListActivatedRulesInRuleGroup`.
"""
@spec get_rule_group(map(), get_rule_group_request(), list()) ::
{:ok, get_rule_group_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_rule_group_errors()}
def get_rule_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRuleGroup", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Gets detailed information about a specified number of requests--a sample--that
AWS WAF randomly selects from among the first 5,000 requests that your AWS
resource received during a time range that you choose. You can specify a sample
size of up to 500 requests, and you can specify any time range in the previous
three hours.
`GetSampledRequests` returns a time range, which is usually the time range that
you specified. However, if your resource
(such as a CloudFront distribution) received 5,000 requests before the specified
time range elapsed, `GetSampledRequests`
returns an updated time range. This new time range indicates the actual period
during which AWS WAF selected the requests in the sample.
"""
@spec get_sampled_requests(map(), get_sampled_requests_request(), list()) ::
{:ok, get_sampled_requests_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_sampled_requests_errors()}
def get_sampled_requests(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetSampledRequests", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `SizeConstraintSet` specified by `SizeConstraintSetId`.
"""
@spec get_size_constraint_set(map(), get_size_constraint_set_request(), list()) ::
{:ok, get_size_constraint_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_size_constraint_set_errors()}
def get_size_constraint_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetSizeConstraintSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `SqlInjectionMatchSet` that is specified by
`SqlInjectionMatchSetId`.
"""
@spec get_sql_injection_match_set(map(), get_sql_injection_match_set_request(), list()) ::
{:ok, get_sql_injection_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_sql_injection_match_set_errors()}
def get_sql_injection_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetSqlInjectionMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `WebACL` that is specified by `WebACLId`.
"""
@spec get_web_acl(map(), get_web_acl_request(), list()) ::
{:ok, get_web_acl_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_web_acl_errors()}
def get_web_acl(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetWebACL", input, options)
end
@doc """
This is **AWS WAF Classic Regional** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the web ACL for the specified resource, either an application load
balancer or Amazon API Gateway stage.
"""
@spec get_web_acl_for_resource(map(), get_web_acl_for_resource_request(), list()) ::
{:ok, get_web_acl_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_web_acl_for_resource_errors()}
def get_web_acl_for_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetWebACLForResource", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns the `XssMatchSet` that is specified by `XssMatchSetId`.
"""
@spec get_xss_match_set(map(), get_xss_match_set_request(), list()) ::
{:ok, get_xss_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_xss_match_set_errors()}
def get_xss_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetXssMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `ActivatedRule` objects.
"""
@spec list_activated_rules_in_rule_group(
map(),
list_activated_rules_in_rule_group_request(),
list()
) ::
{:ok, list_activated_rules_in_rule_group_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_activated_rules_in_rule_group_errors()}
def list_activated_rules_in_rule_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListActivatedRulesInRuleGroup", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `ByteMatchSetSummary` objects.
"""
@spec list_byte_match_sets(map(), list_byte_match_sets_request(), list()) ::
{:ok, list_byte_match_sets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_byte_match_sets_errors()}
def list_byte_match_sets(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListByteMatchSets", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `GeoMatchSetSummary` objects in the response.
"""
@spec list_geo_match_sets(map(), list_geo_match_sets_request(), list()) ::
{:ok, list_geo_match_sets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_geo_match_sets_errors()}
def list_geo_match_sets(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListGeoMatchSets", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `IPSetSummary` objects in the response.
"""
@spec list_ip_sets(map(), list_ip_sets_request(), list()) ::
{:ok, list_ip_sets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_ip_sets_errors()}
def list_ip_sets(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListIPSets", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `LoggingConfiguration` objects.
"""
@spec list_logging_configurations(map(), list_logging_configurations_request(), list()) ::
{:ok, list_logging_configurations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_logging_configurations_errors()}
def list_logging_configurations(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListLoggingConfigurations", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `RuleSummary` objects.
"""
@spec list_rate_based_rules(map(), list_rate_based_rules_request(), list()) ::
{:ok, list_rate_based_rules_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_rate_based_rules_errors()}
def list_rate_based_rules(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListRateBasedRules", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `RegexMatchSetSummary` objects.
"""
@spec list_regex_match_sets(map(), list_regex_match_sets_request(), list()) ::
{:ok, list_regex_match_sets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_regex_match_sets_errors()}
def list_regex_match_sets(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListRegexMatchSets", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `RegexPatternSetSummary` objects.
"""
@spec list_regex_pattern_sets(map(), list_regex_pattern_sets_request(), list()) ::
{:ok, list_regex_pattern_sets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_regex_pattern_sets_errors()}
def list_regex_pattern_sets(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListRegexPatternSets", input, options)
end
@doc """
This is **AWS WAF Classic Regional** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of resources associated with the specified web ACL.
"""
@spec list_resources_for_web_acl(map(), list_resources_for_web_acl_request(), list()) ::
{:ok, list_resources_for_web_acl_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_resources_for_web_acl_errors()}
def list_resources_for_web_acl(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListResourcesForWebACL", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `RuleGroup` objects.
"""
@spec list_rule_groups(map(), list_rule_groups_request(), list()) ::
{:ok, list_rule_groups_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_rule_groups_errors()}
def list_rule_groups(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListRuleGroups", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `RuleSummary` objects.
"""
@spec list_rules(map(), list_rules_request(), list()) ::
{:ok, list_rules_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_rules_errors()}
def list_rules(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListRules", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `SizeConstraintSetSummary` objects.
"""
@spec list_size_constraint_sets(map(), list_size_constraint_sets_request(), list()) ::
{:ok, list_size_constraint_sets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_size_constraint_sets_errors()}
def list_size_constraint_sets(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListSizeConstraintSets", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `SqlInjectionMatchSet` objects.
"""
@spec list_sql_injection_match_sets(map(), list_sql_injection_match_sets_request(), list()) ::
{:ok, list_sql_injection_match_sets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_sql_injection_match_sets_errors()}
def list_sql_injection_match_sets(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListSqlInjectionMatchSets", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `RuleGroup` objects that you are subscribed to.
"""
@spec list_subscribed_rule_groups(map(), list_subscribed_rule_groups_request(), list()) ::
{:ok, list_subscribed_rule_groups_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_subscribed_rule_groups_errors()}
def list_subscribed_rule_groups(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListSubscribedRuleGroups", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Retrieves the tags associated with the specified AWS resource. Tags are
key:value pairs that you can use to categorize and manage your resources, for
purposes like billing. For example, you might set the tag key to "customer" and
the value to the customer name or ID. You can specify one or more tags to add to
each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or
view tags through the AWS WAF Classic console. You can tag the AWS resources
that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
"""
@spec list_tags_for_resource(map(), list_tags_for_resource_request(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListTagsForResource", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `WebACLSummary` objects in the response.
"""
@spec list_web_acls(map(), list_web_acls_request(), list()) ::
{:ok, list_web_acls_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_web_acls_errors()}
def list_web_acls(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListWebACLs", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Returns an array of `XssMatchSet` objects.
"""
@spec list_xss_match_sets(map(), list_xss_match_sets_request(), list()) ::
{:ok, list_xss_match_sets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_xss_match_sets_errors()}
def list_xss_match_sets(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListXssMatchSets", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Associates a `LoggingConfiguration` with a specified web ACL.
You can access information about all traffic that AWS WAF inspects using the
following
steps:
1.
Create an Amazon Kinesis Data
Firehose.
Create the data firehose with a PUT source and in the region that you are
operating. However, if you are capturing logs for Amazon CloudFront, always
create the firehose in US East (N. Virginia).
Do not create the data firehose using a `Kinesis stream` as your source.
2.
Associate that firehose to your web ACL using a `PutLoggingConfiguration`
request.
When you successfully enable logging using a `PutLoggingConfiguration` request,
AWS WAF will create a service linked role with the necessary permissions to
write logs to the Amazon Kinesis Data Firehose. For more information, see
[Logging Web ACL Traffic Information](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html)
in the *AWS WAF Developer Guide*.
"""
@spec put_logging_configuration(map(), put_logging_configuration_request(), list()) ::
{:ok, put_logging_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_logging_configuration_errors()}
def put_logging_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PutLoggingConfiguration", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Attaches an IAM policy to the specified resource. The only supported use for
this action is to share a RuleGroup across accounts.
The `PutPermissionPolicy` is subject to the following restrictions:
*
You can attach only one policy with each `PutPermissionPolicy` request.
*
The policy must include an `Effect`, `Action` and `Principal`.
*
`Effect` must specify `Allow`.
*
The `Action` in the policy must be `waf:UpdateWebACL`,
`waf-regional:UpdateWebACL`, `waf:GetRuleGroup` and `waf-regional:GetRuleGroup`
. Any extra or wildcard actions in the policy will be rejected.
*
The policy cannot include a `Resource` parameter.
*
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must
exist in the same region.
*
The user making the request must be the owner of the RuleGroup.
*
Your policy must be composed using IAM Policy version 2012-10-17.
For more information, see [IAM Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html).
An example of a valid policy parameter is shown in the Examples section below.
"""
@spec put_permission_policy(map(), put_permission_policy_request(), list()) ::
{:ok, put_permission_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_permission_policy_errors()}
def put_permission_policy(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PutPermissionPolicy", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Associates tags with the specified AWS resource. Tags are key:value pairs that
you can use to categorize and manage your resources, for purposes like billing.
For example, you might set the tag key to "customer" and the value to the
customer name or ID. You can specify one or more tags to add to each AWS
resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or
view tags through the AWS WAF Classic console. You can use this action to tag
the AWS resources that you manage through AWS WAF Classic: web ACLs, rule
groups, and rules.
"""
@spec tag_resource(map(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "TagResource", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
"""
@spec untag_resource(map(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UntagResource", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Inserts or deletes `ByteMatchTuple` objects (filters) in a `ByteMatchSet`. For
each `ByteMatchTuple` object,
you specify the following values:
*
Whether to insert or delete the object from the array. If you want to change a
`ByteMatchSetUpdate` object,
you delete the existing object and add a new one.
*
The part of a web request that you want AWS WAF to inspect, such as a query
string or the value of the `User-Agent` header.
*
The bytes (typically a string that corresponds with ASCII characters) that you
want AWS WAF to look for. For more information, including how you specify
the values for the AWS WAF API and the AWS CLI or SDKs, see `TargetString` in
the `ByteMatchTuple` data type.
*
Where to look, such as at the beginning or the end of a query string.
*
Whether to perform any conversions on the request, such as converting it to
lowercase, before inspecting it for the specified string.
For example, you can add a `ByteMatchSetUpdate` object that matches web requests
in which `User-Agent` headers contain
the string `BadBot`. You can then configure AWS WAF to block those requests.
To create and configure a `ByteMatchSet`, perform the following steps:
1.
Create a `ByteMatchSet.` For more information, see `CreateByteMatchSet`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateByteMatchSet` request.
3.
Submit an `UpdateByteMatchSet` request to specify the part of the request that
you want AWS WAF to inspect
(for example, the header or the URI) and the value that you want AWS WAF to
watch for.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec update_byte_match_set(map(), update_byte_match_set_request(), list()) ::
{:ok, update_byte_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_byte_match_set_errors()}
def update_byte_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateByteMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Inserts or deletes `GeoMatchConstraint` objects in an `GeoMatchSet`. For each
`GeoMatchConstraint` object,
you specify the following values:
*
Whether to insert or delete the object from the array. If you want to change an
`GeoMatchConstraint` object, you delete the existing object and add a new one.
*
The `Type`. The only valid value for `Type` is `Country`.
*
The `Value`, which is a two character code for the country to add to the
`GeoMatchConstraint` object. Valid codes are listed in
`GeoMatchConstraint$Value`.
To create and configure an `GeoMatchSet`, perform the following steps:
1.
Submit a `CreateGeoMatchSet` request.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateGeoMatchSet` request.
3.
Submit an `UpdateGeoMatchSet` request to specify the country that you want AWS
WAF to watch for.
When you update an `GeoMatchSet`, you specify the country that you want to add
and/or the country that you want to delete.
If you want to change a country, you delete the existing country and add the new
one.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec update_geo_match_set(map(), update_geo_match_set_request(), list()) ::
{:ok, update_geo_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_geo_match_set_errors()}
def update_geo_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateGeoMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Inserts or deletes `IPSetDescriptor` objects in an
`IPSet`. For each `IPSetDescriptor` object, you specify the following
values:
*
Whether to insert or delete the object from the array. If you want to change an
`IPSetDescriptor` object, you delete the existing object and add a new
one.
*
The IP address version, `IPv4` or `IPv6`.
*
The IP address in CIDR notation, for example, `192.0.2.0/24` (for
the range of IP addresses from `192.0.2.0` to `192.0.2.255`) or
`192.0.2.44/32` (for the individual IP address
`192.0.2.44`).
AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32.
AWS
WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more
information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain
Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).
IPv6 addresses can be represented using any of the following formats:
*
1111:0000:0000:0000:0000:0000:0000:0111/128
*
1111:0:0:0:0:0:0:0111/128
*
1111::0111/128
*
1111::111/128
You use an `IPSet` to specify which web requests you want to allow or
block based on the IP addresses that the requests originated from. For example,
if you're
receiving a lot of requests from one or a small number of IP addresses and you
want to
block the requests, you can create an `IPSet` that specifies those IP addresses,
and then configure AWS WAF to block the requests.
To create and configure an `IPSet`, perform the following steps:
1.
Submit a `CreateIPSet` request.
2.
Use `GetChangeToken` to get the change token that you provide
in the `ChangeToken` parameter of an `UpdateIPSet`
request.
3.
Submit an `UpdateIPSet` request to specify the IP addresses that you
want AWS WAF to watch for.
When you update an `IPSet`, you specify the IP addresses that you want to
add and/or the IP addresses that you want to delete. If you want to change an IP
address,
you delete the existing IP address and add the new one.
You can insert a maximum of 1000 addresses in a single
request.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec update_ip_set(map(), update_ip_set_request(), list()) ::
{:ok, update_ip_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_ip_set_errors()}
def update_ip_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateIPSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Inserts or deletes `Predicate` objects in a rule and updates the
`RateLimit` in the rule.
Each `Predicate` object identifies a predicate, such as a `ByteMatchSet` or an
`IPSet`, that specifies the web requests
that you want to block or count. The `RateLimit` specifies the number of
requests every five minutes that triggers the rule.
If you add more than one predicate to a `RateBasedRule`, a request must
match all the predicates and exceed the `RateLimit` to be counted or blocked.
For example, suppose you add the following to a `RateBasedRule`:
*
An `IPSet` that matches the IP address `192.0.2.44/32`
*
A `ByteMatchSet` that matches `BadBot` in the
`User-Agent` header
Further, you specify a
`RateLimit` of 1,000.
You then add the `RateBasedRule` to a `WebACL` and specify that
you want to block requests that satisfy the rule. For a request to be blocked,
it must come
from the IP address 192.0.2.44 *and* the `User-Agent` header
in the request must contain the value `BadBot`. Further, requests that match
these two conditions much be received at a rate of more than 1,000 every five
minutes. If
the rate drops below this limit, AWS WAF no longer blocks the requests.
As a second example, suppose you want to limit requests to a particular page on
your site. To do this, you could add the following to a
`RateBasedRule`:
*
A `ByteMatchSet` with `FieldToMatch` of `URI`
*
A `PositionalConstraint` of `STARTS_WITH`
*
A `TargetString` of `login`
Further, you specify a `RateLimit` of 1,000.
By adding this `RateBasedRule` to a `WebACL`, you could limit requests to your
login page without affecting the rest of your site.
"""
@spec update_rate_based_rule(map(), update_rate_based_rule_request(), list()) ::
{:ok, update_rate_based_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_rate_based_rule_errors()}
def update_rate_based_rule(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateRateBasedRule", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Inserts or deletes `RegexMatchTuple` objects (filters) in a `RegexMatchSet`. For
each `RegexMatchSetUpdate` object,
you specify the following values:
*
Whether to insert or delete the object from the array. If you want to change a
`RegexMatchSetUpdate` object,
you delete the existing object and add a new one.
*
The part of a web request that you want AWS WAF to inspectupdate, such as a
query string or the value of the `User-Agent` header.
*
The identifier of the pattern (a regular expression) that you want AWS WAF to
look for. For more information, see `RegexPatternSet`.
*
Whether to perform any conversions on the request, such as converting it to
lowercase, before inspecting it for the specified string.
For example, you can create a `RegexPatternSet` that matches any requests with
`User-Agent` headers
that contain the string `B[a@]dB[o0]t`. You can then configure AWS WAF to reject those requests.
To create and configure a `RegexMatchSet`, perform the following steps:
1.
Create a `RegexMatchSet.` For more information, see `CreateRegexMatchSet`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateRegexMatchSet` request.
3.
Submit an `UpdateRegexMatchSet` request to specify the part of the request that
you want AWS WAF to inspect
(for example, the header or the URI) and the identifier of the `RegexPatternSet`
that contain the regular expression patters you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer
Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec update_regex_match_set(map(), update_regex_match_set_request(), list()) ::
{:ok, update_regex_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_regex_match_set_errors()}
def update_regex_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateRegexMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Inserts or deletes `RegexPatternString` objects in a `RegexPatternSet`. For each
`RegexPatternString` object,
you specify the following values:
*
Whether to insert or delete the `RegexPatternString`.
*
The regular expression pattern that you want to insert or delete. For more
information, see `RegexPatternSet`.
For example, you can create a `RegexPatternString` such as `B[a@]dB[o0]t`. AWS WAF will match this `RegexPatternString` to:
*
BadBot
*
BadB0t
*
B@dBot
*
B@dB0t
To create and configure a `RegexPatternSet`, perform the following steps:
1.
Create a `RegexPatternSet.` For more information, see `CreateRegexPatternSet`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateRegexPatternSet` request.
3.
Submit an `UpdateRegexPatternSet` request to specify the regular expression
pattern that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer
Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec update_regex_pattern_set(map(), update_regex_pattern_set_request(), list()) ::
{:ok, update_regex_pattern_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_regex_pattern_set_errors()}
def update_regex_pattern_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateRegexPatternSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Inserts or deletes `Predicate` objects in a `Rule`. Each
`Predicate` object identifies a predicate, such as a `ByteMatchSet` or an
`IPSet`, that specifies the web requests
that you want to allow, block, or count. If you add more than one predicate to a
`Rule`, a request must match all of the specifications to be allowed,
blocked, or counted. For example, suppose
that
you add the following to a `Rule`:
*
A `ByteMatchSet` that matches the value `BadBot` in the `User-Agent` header
*
An `IPSet` that matches the IP address `192.0.2.44`
You then add the `Rule` to a `WebACL` and specify that you want to block
requests that satisfy the `Rule`.
For a request to be blocked, the `User-Agent` header in the request must contain
the value `BadBot`
*and* the request must originate from the IP address 192.0.2.44.
To create and configure a `Rule`, perform the following steps:
1.
Create and update the predicates that you want to include in the `Rule`.
2.
Create the `Rule`. See `CreateRule`.
3.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateRule` request.
4.
Submit an `UpdateRule` request to add predicates to the `Rule`.
5.
Create and update a `WebACL` that contains the `Rule`. See `CreateWebACL`.
If you want to replace one `ByteMatchSet` or `IPSet` with another, you delete
the existing one and
add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec update_rule(map(), update_rule_request(), list()) ::
{:ok, update_rule_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_rule_errors()}
def update_rule(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateRule", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Inserts or deletes `ActivatedRule` objects in a `RuleGroup`.
You can only insert `REGULAR` rules into a rule group.
You can have a maximum of ten rules per rule group.
To create and configure a `RuleGroup`, perform the following steps:
1.
Create and update the `Rules` that you want to include in the `RuleGroup`. See
`CreateRule`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateRuleGroup` request.
3.
Submit an `UpdateRuleGroup` request to add `Rules` to the `RuleGroup`.
4.
Create and update a `WebACL` that contains the `RuleGroup`. See `CreateWebACL`.
If you want to replace one `Rule` with another, you delete the existing one and
add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec update_rule_group(map(), update_rule_group_request(), list()) ::
{:ok, update_rule_group_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_rule_group_errors()}
def update_rule_group(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateRuleGroup", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Inserts or deletes `SizeConstraint` objects (filters) in a `SizeConstraintSet`.
For each `SizeConstraint` object,
you specify the following values:
*
Whether to insert or delete the object from the array. If you want to change a
`SizeConstraintSetUpdate` object,
you delete the existing object and add a new one.
*
The part of a web request that you want AWS WAF to evaluate, such as the length
of a query string or the length of the
`User-Agent` header.
*
Whether to perform any transformations on the request, such as converting it to
lowercase, before checking its length.
Note that transformations of the request body are not supported because the AWS
resource forwards only the first `8192` bytes
of your request to AWS WAF.
You can only specify a single type of TextTransformation.
*
A `ComparisonOperator` used for evaluating the selected part of the request
against the specified `Size`, such as
equals, greater than, less than, and so on.
*
The length, in bytes, that you want AWS WAF to watch for in selected part of the
request. The length is computed after applying the transformation.
For example, you can add a `SizeConstraintSetUpdate` object that matches web
requests in which the length of the
`User-Agent` header is greater than 100 bytes. You can then configure AWS WAF to
block those requests.
To create and configure a `SizeConstraintSet`, perform the following steps:
1.
Create a `SizeConstraintSet.` For more information, see
`CreateSizeConstraintSet`.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateSizeConstraintSet` request.
3.
Submit an `UpdateSizeConstraintSet` request to specify the part of the request
that you want AWS WAF to inspect
(for example, the header or the URI) and the value that you want AWS WAF to
watch for.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec update_size_constraint_set(map(), update_size_constraint_set_request(), list()) ::
{:ok, update_size_constraint_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_size_constraint_set_errors()}
def update_size_constraint_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateSizeConstraintSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Inserts or deletes `SqlInjectionMatchTuple` objects (filters) in a
`SqlInjectionMatchSet`.
For each `SqlInjectionMatchTuple` object, you specify the following values:
*
`Action`: Whether to insert the object into or delete the object from the array.
To change a
`SqlInjectionMatchTuple`, you delete the existing object and add a new one.
*
`FieldToMatch`: The part of web requests that you want AWS WAF to inspect and,
if you want AWS WAF to inspect a header or custom query parameter,
the name of the header or parameter.
*
`TextTransformation`: Which text transformation, if any, to perform on the web
request before
inspecting the request for snippets of malicious SQL code.
You can only specify a single type of TextTransformation.
You use `SqlInjectionMatchSet` objects to specify which CloudFront
requests that
you want to allow, block, or count. For example, if you're receiving
requests that contain snippets of SQL code in the query string and you want to
block the
requests, you can create a `SqlInjectionMatchSet` with the applicable settings,
and then configure AWS WAF to block the requests.
To create and configure a `SqlInjectionMatchSet`, perform the following steps:
1.
Submit a `CreateSqlInjectionMatchSet` request.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateIPSet` request.
3.
Submit an `UpdateSqlInjectionMatchSet` request to specify the parts of web
requests that you want AWS WAF to
inspect for snippets of SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec update_sql_injection_match_set(map(), update_sql_injection_match_set_request(), list()) ::
{:ok, update_sql_injection_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_sql_injection_match_set_errors()}
def update_sql_injection_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateSqlInjectionMatchSet", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Inserts or deletes `ActivatedRule` objects in a `WebACL`. Each `Rule` identifies
web requests that you want to allow, block, or count. When you update a
`WebACL`, you specify the following values:
*
A default action for the `WebACL`, either `ALLOW` or `BLOCK`.
AWS WAF performs the default action if a request doesn't match the criteria in
any of the `Rules` in a `WebACL`.
*
The `Rules` that you want to add
or
delete. If you want to replace one `Rule` with another, you delete the
existing `Rule` and add the new one.
*
For each `Rule`, whether you want AWS WAF to allow requests, block requests, or
count requests that match
the conditions in the `Rule`.
*
The order in which you want AWS WAF to evaluate the `Rules` in a
`WebACL`. If you add more than one `Rule` to a
`WebACL`, AWS WAF evaluates each request against the `Rules`
in order based on the value of `Priority`. (The `Rule` that has
the lowest value for `Priority` is evaluated first.) When a web request
matches all
the
predicates (such as `ByteMatchSets` and `IPSets`) in a
`Rule`, AWS WAF immediately takes the corresponding action, allow or
block, and doesn't evaluate the request against the remaining `Rules` in
the `WebACL`, if any.
To create and configure a `WebACL`, perform the following steps:
1.
Create and update the predicates that you want to include in `Rules`.
For more information, see `CreateByteMatchSet`, `UpdateByteMatchSet`,
`CreateIPSet`, `UpdateIPSet`,
`CreateSqlInjectionMatchSet`, and `UpdateSqlInjectionMatchSet`.
2.
Create and update the `Rules` that you want to include in the `WebACL`. For more
information, see
`CreateRule` and `UpdateRule`.
3.
Create a `WebACL`. See `CreateWebACL`.
4.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateWebACL` request.
5.
Submit an `UpdateWebACL` request to specify the `Rules`
that you want to include in the `WebACL`, to specify the default action,
and to associate the `WebACL` with a CloudFront distribution.
The `ActivatedRule` can be a rule group. If you specify a rule group
as your
`ActivatedRule`
,
you can exclude specific rules from that rule group.
If you already have a rule group associated with a web ACL and want to submit
an `UpdateWebACL` request to exclude certain rules from that rule group,
you must first remove the rule group from the web ACL, the re-insert it again,
specifying the excluded rules.
For details,
see
`ActivatedRule$ExcludedRules`
.
Be aware that if you try to add a RATE_BASED rule to a web ACL without setting
the rule type when first creating the rule, the `UpdateWebACL` request will fail
because the request tries to add a REGULAR rule (the default rule type) with the
specified ID, which does not exist.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec update_web_acl(map(), update_web_acl_request(), list()) ::
{:ok, update_web_acl_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_web_acl_errors()}
def update_web_acl(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateWebACL", input, options)
end
@doc """
This is **AWS WAF Classic** documentation.
For
more information, see [AWS WAF
Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
in the developer guide.
**For the latest version of AWS
WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
With the latest version, AWS WAF has a single set of endpoints for regional and
global use.
Inserts or deletes `XssMatchTuple` objects (filters) in an `XssMatchSet`.
For each `XssMatchTuple` object, you specify the following values:
*
`Action`: Whether to insert the object into or delete the object from the
array. To change an
`XssMatchTuple`, you delete the existing object and add a new
one.
*
`FieldToMatch`: The part of web requests that you want AWS WAF to inspect and,
if you want AWS WAF to inspect a header or custom query parameter,
the name of the header or parameter.
*
`TextTransformation`: Which text transformation, if any, to perform on the web
request before
inspecting the request for cross-site scripting attacks.
You can only specify a single type of TextTransformation.
You use `XssMatchSet` objects to specify which CloudFront requests
that
you want to allow, block, or count. For example, if you're receiving
requests that contain cross-site scripting attacks in the request body and you
want to
block the requests, you can create an `XssMatchSet` with the applicable
settings, and then configure AWS WAF to block the requests.
To create and configure an `XssMatchSet`, perform the following steps:
1.
Submit a `CreateXssMatchSet` request.
2.
Use `GetChangeToken` to get the change token that you provide in the
`ChangeToken` parameter of an
`UpdateIPSet` request.
3.
Submit an `UpdateXssMatchSet` request to specify the parts of web requests that
you want AWS WAF to
inspect for cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the
[AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/).
"""
@spec update_xss_match_set(map(), update_xss_match_set_request(), list()) ::
{:ok, update_xss_match_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_xss_match_set_errors()}
def update_xss_match_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateXssMatchSet", input, options)
end
end
