Module Smaws_Client_WAF

WAF client library built on EIO.

Types

type match_field_type =
  1. | ALL_QUERY_ARGS
  2. | SINGLE_QUERY_ARG
  3. | BODY
  4. | METHOD
  5. | HEADER
  6. | QUERY_STRING
  7. | URI
type field_to_match = {
  1. data : string option;
    (*

    When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

    When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

    If the value of Type is any other value, omit Data.

    *)
  2. type_ : match_field_type;
    (*

    The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

    • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
    • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
    • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
    • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
    • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.
    • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.
    • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.
    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies where in a web request to look for TargetString.

type text_transformation =
  1. | URL_DECODE
  2. | CMD_LINE
  3. | LOWERCASE
  4. | HTML_ENTITY_DECODE
  5. | COMPRESS_WHITE_SPACE
  6. | NONE
type xss_match_tuple = {
  1. text_transformation : text_transformation;
    (*

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \ " ' ^
    • Delete spaces before the following characters: / (
    • Replace the following characters with a space: , ;
    • Replace multiple spaces with one space
    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \f, formfeed, decimal 12
    • \t, tab, decimal 9
    • \n, newline, decimal 10
    • \r, carriage return, decimal 13
    • \v, vertical tab, decimal 11
    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with "
    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
    • Replaces (ampersand)lt; with a "less than" symbol
    • Replaces (ampersand)gt; with >
    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    *)
  2. field_to_match : field_to_match;
    (*

    Specifies where in a web request to look for cross-site scripting attacks.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

type change_action =
  1. | DELETE
  2. | INSERT
type xss_match_set_update = {
  1. xss_match_tuple : xss_match_tuple;
    (*

    Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

    *)
  2. action : change_action;
    (*

    Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the specification to an XssMatchSet or delete it from an XssMatchSet.

type xss_match_set_summary = {
  1. name : string;
    (*

    The name of the XssMatchSet, if any, specified by Id.

    *)
  2. xss_match_set_id : string;
    (*

    A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

    XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The Id and Name of an XssMatchSet.

type xss_match_set = {
  1. xss_match_tuples : xss_match_tuple list;
    (*

    Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

    *)
  2. name : string option;
    (*

    The name, if any, of the XssMatchSet.

    *)
  3. xss_match_set_id : string;
    (*

    A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

    XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.

type waf_action_type =
  1. | COUNT
  2. | ALLOW
  3. | BLOCK
type waf_action = {
  1. type_ : waf_action_type;
    (*

    Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

    • ALLOW: AWS WAF allows requests
    • BLOCK: AWS WAF blocks requests
    • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.
    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL.

type waf_override_action_type =
  1. | COUNT
  2. | NONE
type waf_override_action = {
  1. type_ : waf_override_action_type;
    (*

    COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The action to take if any rule within the RuleGroup matches a request.

type waf_rule_type =
  1. | GROUP
  2. | RATE_BASED
  3. | REGULAR
type excluded_rule = {
  1. rule_id : string;
    (*

    The unique identifier for the rule to exclude from the rule group.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The rule to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. The rule must belong to the RuleGroup that is specified by the ActivatedRule.

type activated_rule = {
  1. excluded_rules : excluded_rule list option;
    (*

    An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.

    Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.

    Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule.

    If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

    1. Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.

    2. Submit an UpdateWebACL request that has two actions:

      • The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude.
      • The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.
    *)
  2. type_ : waf_rule_type option;
    (*

    The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

    *)
  3. override_action : waf_override_action option;
    (*

    Use the OverrideAction to test your RuleGroup.

    Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.

    ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    *)
  4. action : waf_action option;
    (*

    Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

    • ALLOW: CloudFront responds with the requested object.
    • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
    • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

    ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    *)
  5. rule_id : string;
    (*

    The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    RuleId is returned by CreateRule and by ListRules.

    *)
  6. priority : int;
    (*

    Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.

type web_acl_update = {
  1. activated_rule : activated_rule;
    (*

    The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

    *)
  2. action : change_action;
    (*

    Specifies whether to insert a Rule into or delete a Rule from a WebACL.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies whether to insert a Rule into or delete a Rule from a WebACL.

type web_acl_summary = {
  1. name : string;
    (*

    A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

    *)
  2. web_acl_id : string;
    (*

    A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

    WebACLId is returned by CreateWebACL and by ListWebACLs.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the name or description of the WebACL.

type web_ac_l = {
  1. web_acl_arn : string option;
    (*

    Tha Amazon Resource Name (ARN) of the web ACL.

    *)
  2. rules : activated_rule list;
    (*

    An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

    *)
  3. default_action : waf_action;
    (*

    The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

    *)
  4. metric_name : string option;
    (*

    A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL.

    *)
  5. name : string option;
    (*

    A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

    *)
  6. web_acl_id : string;
    (*

    A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

    WebACLId is returned by CreateWebACL and by ListWebACLs.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

type waf_tag_operation_internal_error_exception = {
  1. message : string option;
}
type waf_tag_operation_exception = {
  1. message : string option;
}
type waf_subscription_not_found_exception = {
  1. message : string option;
}

The specified subscription does not exist.

type waf_stale_data_exception = {
  1. message : string option;
}

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

type waf_service_linked_role_error_exception = {
  1. message : string option;
}

AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.

type waf_referenced_item_exception = {
  1. message : string option;
}

The operation failed because you tried to delete an object that is still in use. For example:

  • You tried to delete a ByteMatchSet that is still referenced by a Rule.
  • You tried to delete a Rule that is still referenced by a WebACL.
type waf_nonexistent_item_exception = {
  1. message : string option;
}

The operation failed because the referenced object doesn't exist.

type waf_nonexistent_container_exception = {
  1. message : string option;
}

The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

  • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.
  • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.
  • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
  • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.
type waf_non_empty_entity_exception = {
  1. message : string option;
}

The operation failed because you tried to delete an object that isn't empty. For example:

  • You tried to delete a WebACL that still contains one or more Rule objects.
  • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.
  • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.
  • You tried to delete an IPSet that references one or more IP addresses.
type waf_limits_exceeded_exception = {
  1. message : string option;
}

The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.

type waf_invalid_regex_pattern_exception = {
  1. message : string option;
}

The regular expression (regex) you specified in RegexPatternString is invalid.

type waf_invalid_permission_policy_exception = {
  1. message : string option;
}

The operation failed because the specified policy is not in the proper format.

The policy 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.
type parameter_exception_field =
  1. | TAG_KEYS
  2. | TAGS
  3. | RESOURCE_ARN
  4. | NEXT_MARKER
  5. | RULE_TYPE
  6. | RATE_KEY
  7. | GEO_MATCH_LOCATION_VALUE
  8. | GEO_MATCH_LOCATION_TYPE
  9. | SIZE_CONSTRAINT_COMPARISON_OPERATOR
  10. | BYTE_MATCH_POSITIONAL_CONSTRAINT
  11. | BYTE_MATCH_TEXT_TRANSFORMATION
  12. | SQL_INJECTION_MATCH_FIELD_TYPE
  13. | BYTE_MATCH_FIELD_TYPE
  14. | IPSET_TYPE
  15. | PREDICATE_TYPE
  16. | WAF_OVERRIDE_ACTION
  17. | WAF_ACTION
  18. | CHANGE_ACTION
type parameter_exception_reason =
  1. | INVALID_TAG_KEY
  2. | ILLEGAL_ARGUMENT
  3. | ILLEGAL_COMBINATION
  4. | INVALID_OPTION
type waf_invalid_parameter_exception = {
  1. reason : parameter_exception_reason option;
  2. parameter : string option;
  3. field : parameter_exception_field option;
}

The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

  • You specified an invalid parameter name.
  • You specified an invalid value.
  • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.
  • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.
  • You tried to create a RateBasedRule with a RateKey value other than IP.
  • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.
  • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.
  • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.
  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
type waf_invalid_operation_exception = {
  1. message : string option;
}

The operation failed because there was nothing to do. For example:

  • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.
  • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.
  • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.
  • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.
  • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.
type waf_invalid_account_exception = unit

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

type waf_internal_error_exception = {
  1. message : string option;
}

The operation failed because of a system problem, even though the request was valid. Retry your request.

type migration_error_type =
  1. | S3_INTERNAL_ERROR
  2. | S3_BUCKET_INVALID_REGION
  3. | S3_BUCKET_NOT_FOUND
  4. | S3_BUCKET_NOT_ACCESSIBLE
  5. | S3_BUCKET_NO_PERMISSION
  6. | ENTITY_NOT_FOUND
  7. | ENTITY_NOT_SUPPORTED
type waf_entity_migration_exception = {
  1. migration_error_reason : string option;
  2. migration_error_type : migration_error_type option;
  3. message : string option;
}

The operation failed due to a problem with the migration. The failure cause is provided in the exception, in the MigrationErrorType:

  • ENTITY_NOT_SUPPORTED - The web ACL has an unsupported entity but the IgnoreUnsupportedType is not set to true.
  • ENTITY_NOT_FOUND - The web ACL doesn't exist.
  • S3_BUCKET_NO_PERMISSION - You don't have permission to perform the PutObject action to the specified Amazon S3 bucket.
  • S3_BUCKET_NOT_ACCESSIBLE - The bucket policy doesn't allow AWS WAF to perform the PutObject action in the bucket.
  • S3_BUCKET_NOT_FOUND - The S3 bucket doesn't exist.
  • S3_BUCKET_INVALID_REGION - The S3 bucket is not in the same Region as the web ACL.
  • S3_INTERNAL_ERROR - AWS WAF failed to create the template in the S3 bucket for another reason.
type waf_disallowed_name_exception = {
  1. message : string option;
}

The name specified is invalid.

type waf_bad_request_exception = {
  1. message : string option;
}
type update_xss_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}

The response to an UpdateXssMatchSets request.

type update_xss_match_set_request = {
  1. updates : xss_match_set_update list;
    (*

    An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types:

    • XssMatchSetUpdate: Contains Action and XssMatchTuple
    • XssMatchTuple: Contains FieldToMatch and TextTransformation
    • FieldToMatch: Contains Data and Type
    *)
  2. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  3. xss_match_set_id : string;
    (*

    The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    *)
}

A request to update an XssMatchSet.

type update_web_acl_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type update_web_acl_request = {
  1. default_action : waf_action option;
    (*

    A default action for the web ACL, 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 web ACL.

    *)
  2. updates : web_acl_update list option;
    (*

    An array of updates to make to the WebACL.

    An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

    • WebACLUpdate: Contains Action and ActivatedRule
    • ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
    • WafAction: Contains Type
    *)
  3. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  4. web_acl_id : string;
    (*

    The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.

    *)
}
type update_sql_injection_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}

The response to an UpdateSqlInjectionMatchSets request.

type sql_injection_match_tuple = {
  1. text_transformation : text_transformation;
    (*

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \ " ' ^
    • Delete spaces before the following characters: / (
    • Replace the following characters with a space: , ;
    • Replace multiple spaces with one space
    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \f, formfeed, decimal 12
    • \t, tab, decimal 9
    • \n, newline, decimal 10
    • \r, carriage return, decimal 13
    • \v, vertical tab, decimal 11
    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with "
    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
    • Replaces (ampersand)lt; with a "less than" symbol
    • Replaces (ampersand)gt; with >
    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    *)
  2. field_to_match : field_to_match;
    (*

    Specifies where in a web request to look for snippets of malicious SQL code.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

type sql_injection_match_set_update = {
  1. sql_injection_match_tuple : sql_injection_match_tuple;
    (*

    Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

    *)
  2. action : change_action;
    (*

    Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the specification to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet.

type update_sql_injection_match_set_request = {
  1. updates : sql_injection_match_set_update list;
    (*

    An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types:

    • SqlInjectionMatchSetUpdate: Contains Action and SqlInjectionMatchTuple
    • SqlInjectionMatchTuple: Contains FieldToMatch and TextTransformation
    • FieldToMatch: Contains Data and Type
    *)
  2. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  3. sql_injection_match_set_id : string;
    (*

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    *)
}

A request to update a SqlInjectionMatchSet.

type update_size_constraint_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type comparison_operator =
  1. | GT
  2. | GE
  3. | LT
  4. | LE
  5. | NE
  6. | EQ

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

type size_constraint = {
  1. size : int;
    (*

    The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

    Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).

    If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

    *)
  2. comparison_operator : comparison_operator;
    (*

    The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

    EQ: Used to test if the Size is equal to the size of the FieldToMatch

    NE: Used to test if the Size is not equal to the size of the FieldToMatch

    LE: Used to test if the Size is less than or equal to the size of the FieldToMatch

    LT: Used to test if the Size is strictly less than the size of the FieldToMatch

    GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch

    GT: Used to test if the Size is strictly greater than the size of the FieldToMatch

    *)
  3. text_transformation : text_transformation;
    (*

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

    You can only specify a single type of TextTransformation.

    Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \ " ' ^
    • Delete spaces before the following characters: / (
    • Replace the following characters with a space: , ;
    • Replace multiple spaces with one space
    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \f, formfeed, decimal 12
    • \t, tab, decimal 9
    • \n, newline, decimal 10
    • \r, carriage return, decimal 13
    • \v, vertical tab, decimal 11
    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with "
    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
    • Replaces (ampersand)lt; with a "less than" symbol
    • Replaces (ampersand)gt; with >
    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    *)
  4. field_to_match : field_to_match;
    (*

    Specifies where in a web request to look for the size constraint.

    *)
}
type size_constraint_set_update = {
  1. size_constraint : size_constraint;
    (*

    Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

    *)
  2. action : change_action;
    (*

    Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want to inspect the size of and indicates whether you want to add the specification to a SizeConstraintSet or delete it from a SizeConstraintSet.

type update_size_constraint_set_request = {
  1. updates : size_constraint_set_update list;
    (*

    An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types:

    • SizeConstraintSetUpdate: Contains Action and SizeConstraint
    • SizeConstraint: Contains FieldToMatch, TextTransformation, ComparisonOperator, and Size
    • FieldToMatch: Contains Data and Type
    *)
  2. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  3. size_constraint_set_id : string;
    (*

    The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    *)
}
type update_rule_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type predicate_type =
  1. | REGEX_MATCH
  2. | XSS_MATCH
  3. | SIZE_CONSTRAINT
  4. | GEO_MATCH
  5. | SQL_INJECTION_MATCH
  6. | BYTE_MATCH
  7. | IP_MATCH
type predicate = {
  1. data_id : string;
    (*

    A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

    *)
  2. type_ : predicate_type;
    (*

    The type of predicate in a Rule, such as ByteMatch or IPSet.

    *)
  3. negated : bool;
    (*

    Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

    Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

type rule_update = {
  1. predicate : predicate;
    (*

    The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

    *)
  2. action : change_action;
    (*

    Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies a Predicate (such as an IPSet) and indicates whether you want to add it to a Rule or delete it from a Rule.

type update_rule_request = {
  1. updates : rule_update list;
    (*

    An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

    • RuleUpdate: Contains Action and Predicate
    • Predicate: Contains DataId, Negated, and Type
    • FieldToMatch: Contains Data and Type
    *)
  2. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  3. rule_id : string;
    (*

    The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

    *)
}
type update_rule_group_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the UpdateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type rule_group_update = {
  1. activated_rule : activated_rule;
    (*

    The ActivatedRule object specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

    *)
  2. action : change_action;
    (*

    Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an ActivatedRule from a RuleGroup.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies an ActivatedRule and indicates whether you want to add it to a RuleGroup or delete it from a RuleGroup.

type update_rule_group_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. updates : rule_group_update list;
    (*

    An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup.

    You can only insert REGULAR rules into a rule group.

    ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    *)
  3. rule_group_id : string;
    (*

    The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    *)
}
type update_regex_pattern_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the UpdateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type regex_pattern_set_update = {
  1. regex_pattern_string : string;
    (*

    Specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t.

    *)
  2. action : change_action;
    (*

    Specifies whether to insert or delete a RegexPatternString.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In an UpdateRegexPatternSet request, RegexPatternSetUpdate specifies whether to insert or delete a RegexPatternString and includes the settings for the RegexPatternString.

type update_regex_pattern_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. updates : regex_pattern_set_update list;
    (*

    An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.

    *)
  3. regex_pattern_set_id : string;
    (*

    The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    *)
}
type update_regex_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the UpdateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type regex_match_tuple = {
  1. regex_pattern_set_id : string;
    (*

    The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

    RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    *)
  2. text_transformation : text_transformation;
    (*

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \ " ' ^
    • Delete spaces before the following characters: / (
    • Replace the following characters with a space: , ;
    • Replace multiple spaces with one space
    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \f, formfeed, decimal 12
    • \t, tab, decimal 9
    • \n, newline, decimal 10
    • \r, carriage return, decimal 13
    • \v, vertical tab, decimal 11
    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with "
    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
    • Replaces (ampersand)lt; with a "less than" symbol
    • Replaces (ampersand)gt; with >
    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    *)
  3. field_to_match : field_to_match;
    (*

    Specifies where in a web request to look for the RegexPatternSet.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each RegexMatchTuple object contains:

  • 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 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.
type regex_match_set_update = {
  1. regex_match_tuple : regex_match_tuple;
    (*

    Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE for the value of Action, the RegexMatchTuple values must exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet.

    *)
  2. action : change_action;
    (*

    Specifies whether to insert or delete a RegexMatchTuple.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In an UpdateRegexMatchSet request, RegexMatchSetUpdate specifies whether to insert or delete a RegexMatchTuple and includes the settings for the RegexMatchTuple.

type update_regex_match_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. updates : regex_match_set_update list;
    (*

    An array of RegexMatchSetUpdate objects that you want to insert into or delete from a RegexMatchSet. For more information, see RegexMatchTuple.

    *)
  3. regex_match_set_id : string;
    (*

    The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    *)
}
type update_rate_based_rule_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the UpdateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type update_rate_based_rule_request = {
  1. rate_limit : int;
    (*

    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    *)
  2. updates : rule_update list;
    (*

    An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

    *)
  3. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  4. rule_id : string;
    (*

    The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    *)
}
type update_ip_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type ip_set_descriptor_type =
  1. | IPV6
  2. | IPV4
type ip_set_descriptor = {
  1. value : string;
    (*

    Specify an IPv4 address by using CIDR notation. For example:

    • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

    Specify an IPv6 address by using CIDR notation. For example:

    • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    *)
  2. type_ : ip_set_descriptor_type;
    (*

    Specify IPV4 or IPV6.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the IP address type (IPV4 or IPV6) and the IP address range (in CIDR format) that web requests originate from.

type ip_set_update = {
  1. ip_set_descriptor : ip_set_descriptor;
    (*

    The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from.

    *)
  2. action : change_action;
    (*

    Specifies whether to insert or delete an IP address with UpdateIPSet.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the type of update to perform to an IPSet with UpdateIPSet.

type update_ip_set_request = {
  1. updates : ip_set_update list;
    (*

    An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:

    • IPSetUpdate: Contains Action and IPSetDescriptor
    • IPSetDescriptor: Contains Type and Value

    You can insert a maximum of 1000 addresses in a single request.

    *)
  2. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  3. ip_set_id : string;
    (*

    The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.

    *)
}
type update_geo_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type geo_match_constraint_type =
  1. | Country
type geo_match_constraint_value =
  1. | ZW
  2. | ZM
  3. | YE
  4. | EH
  5. | WF
  6. | VI
  7. | VG
  8. | VN
  9. | VE
  10. | VU
  11. | UZ
  12. | UY
  13. | UM
  14. | US
  15. | GB
  16. | AE
  17. | UA
  18. | UG
  19. | TV
  20. | TC
  21. | TM
  22. | TR
  23. | TN
  24. | TT
  25. | TO
  26. | TK
  27. | TG
  28. | TL
  29. | TH
  30. | TZ
  31. | TJ
  32. | TW
  33. | SY
  34. | CH
  35. | SE
  36. | SZ
  37. | SJ
  38. | SR
  39. | SD
  40. | LK
  41. | ES
  42. | SS
  43. | GS
  44. | ZA
  45. | SO
  46. | SB
  47. | SI
  48. | SK
  49. | SX
  50. | SG
  51. | SL
  52. | SC
  53. | RS
  54. | SN
  55. | SA
  56. | ST
  57. | SM
  58. | WS
  59. | VC
  60. | PM
  61. | MF
  62. | LC
  63. | KN
  64. | SH
  65. | BL
  66. | RW
  67. | RU
  68. | RO
  69. | RE
  70. | QA
  71. | PR
  72. | PT
  73. | PL
  74. | PN
  75. | PH
  76. | PE
  77. | PY
  78. | PG
  79. | PA
  80. | PS
  81. | PW
  82. | PK
  83. | OM
  84. | NO
  85. | MP
  86. | NF
  87. | NU
  88. | NG
  89. | NE
  90. | NI
  91. | NZ
  92. | NC
  93. | NL
  94. | NP
  95. | NR
  96. | NA
  97. | MM
  98. | MZ
  99. | MA
  100. | MS
  101. | ME
  102. | MN
  103. | MC
  104. | MD
  105. | FM
  106. | MX
  107. | YT
  108. | MU
  109. | MR
  110. | MQ
  111. | MH
  112. | MT
  113. | ML
  114. | MV
  115. | MY
  116. | MW
  117. | MG
  118. | MK
  119. | MO
  120. | LU
  121. | LT
  122. | LI
  123. | LY
  124. | LR
  125. | LS
  126. | LB
  127. | LV
  128. | LA
  129. | KG
  130. | KW
  131. | KR
  132. | KP
  133. | KI
  134. | KE
  135. | KZ
  136. | JO
  137. | JE
  138. | JP
  139. | JM
  140. | IT
  141. | IL
  142. | IM
  143. | IE
  144. | IQ
  145. | IR
  146. | ID
  147. | IN
  148. | IS
  149. | HU
  150. | HK
  151. | HN
  152. | VA
  153. | HM
  154. | HT
  155. | GY
  156. | GW
  157. | GN
  158. | GG
  159. | GT
  160. | GU
  161. | GP
  162. | GD
  163. | GL
  164. | GR
  165. | GI
  166. | GH
  167. | DE
  168. | GE
  169. | GM
  170. | GA
  171. | TF
  172. | PF
  173. | GF
  174. | FR
  175. | FI
  176. | FJ
  177. | FO
  178. | FK
  179. | ET
  180. | EE
  181. | ER
  182. | GQ
  183. | SV
  184. | EG
  185. | EC
  186. | DO
  187. | DM
  188. | DJ
  189. | DK
  190. | CZ
  191. | CY
  192. | CW
  193. | CU
  194. | HR
  195. | CI
  196. | CR
  197. | CK
  198. | CD
  199. | CG
  200. | KM
  201. | CO
  202. | CC
  203. | CX
  204. | CN
  205. | CL
  206. | TD
  207. | CF
  208. | KY
  209. | CV
  210. | CA
  211. | CM
  212. | KH
  213. | BI
  214. | BF
  215. | BG
  216. | BN
  217. | IO
  218. | BR
  219. | BV
  220. | BW
  221. | BA
  222. | BQ
  223. | BO
  224. | BT
  225. | BM
  226. | BJ
  227. | BZ
  228. | BE
  229. | BY
  230. | BB
  231. | BD
  232. | BH
  233. | BS
  234. | AZ
  235. | AT
  236. | AU
  237. | AW
  238. | AM
  239. | AR
  240. | AG
  241. | AQ
  242. | AI
  243. | AO
  244. | AD
  245. | AS
  246. | DZ
  247. | AL
  248. | AX
  249. | AF
type geo_match_constraint = {
  1. value : geo_match_constraint_value;
    (*

    The country that you want AWS WAF to search for.

    *)
  2. type_ : geo_match_constraint_type;
    (*

    The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The country from which web requests originate that you want AWS WAF to search for.

type geo_match_set_update = {
  1. geo_match_constraint : geo_match_constraint;
    (*

    The country from which web requests originate that you want AWS WAF to search for.

    *)
  2. action : change_action;
    (*

    Specifies whether to insert or delete a country with UpdateGeoMatchSet.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the type of update to perform to an GeoMatchSet with UpdateGeoMatchSet.

type update_geo_match_set_request = {
  1. updates : geo_match_set_update list;
    (*

    An array of GeoMatchSetUpdate objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types:

    • GeoMatchSetUpdate: Contains Action and GeoMatchConstraint

    • GeoMatchConstraint: Contains Type and Value

      You can have only one Type and Value per GeoMatchConstraint. To add multiple countries, include multiple GeoMatchSetUpdate objects in your request.

    *)
  2. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  3. geo_match_set_id : string;
    (*

    The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    *)
}
type update_byte_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type positional_constraint =
  1. | CONTAINS_WORD
  2. | CONTAINS
  3. | ENDS_WITH
  4. | STARTS_WITH
  5. | EXACTLY
type byte_match_tuple = {
  1. positional_constraint : positional_constraint;
    (*

    Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

    CONTAINS

    The specified part of the web request must include the value of TargetString, but the location doesn't matter.

    CONTAINS_WORD

    The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following:

    • TargetString exactly matches the value of the specified part of the web request, such as the value of a header.
    • TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;.
    • TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot.
    • TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;.

    EXACTLY

    The value of the specified part of the web request must exactly match the value of TargetString.

    STARTS_WITH

    The value of TargetString must appear at the beginning of the specified part of the web request.

    ENDS_WITH

    The value of TargetString must appear at the end of the specified part of the web request.

    *)
  2. text_transformation : text_transformation;
    (*

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \ " ' ^
    • Delete spaces before the following characters: / (
    • Replace the following characters with a space: , ;
    • Replace multiple spaces with one space
    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \f, formfeed, decimal 12
    • \t, tab, decimal 9
    • \n, newline, decimal 10
    • \r, carriage return, decimal 13
    • \v, vertical tab, decimal 11
    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with "
    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
    • Replaces (ampersand)lt; with a "less than" symbol
    • Replaces (ampersand)gt; with >
    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    *)
  3. target_string : bytes;
    (*

    The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.

    Valid values depend on the values that you specified for FieldToMatch:

    • HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.
    • METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
    • QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.
    • URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.
    • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.
    • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.
    • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString.

    If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

    If you're using the AWS WAF API

    Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

    For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of TargetString.

    If you're using the AWS CLI or one of the AWS SDKs

    The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

    *)
  4. field_to_match : field_to_match;
    (*

    The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

type byte_match_set_update = {
  1. byte_match_tuple : byte_match_tuple;
    (*

    Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.

    *)
  2. action : change_action;
    (*

    Specifies whether to insert or delete a ByteMatchTuple.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In an UpdateByteMatchSet request, ByteMatchSetUpdate specifies whether to insert or delete a ByteMatchTuple and includes the settings for the ByteMatchTuple.

type update_byte_match_set_request = {
  1. updates : byte_match_set_update list;
    (*

    An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:

    • ByteMatchSetUpdate: Contains Action and ByteMatchTuple
    • ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation
    • FieldToMatch: Contains Data and Type
    *)
  2. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  3. byte_match_set_id : string;
    (*

    The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    *)
}
type untag_resource_response = unit
type untag_resource_request = {
  1. tag_keys : string list;
  2. resource_ar_n : string;
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests.

You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.

type time_window = {
  1. end_time : float;
    (*

    The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

    *)
  2. start_time : float;
    (*

    The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

    *)
}
type tag_resource_response = unit

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A tag associated with an 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.

type tag = {
  1. value : string;
  2. key : string;
}
type tag_resource_request = {
  1. tags : tag list;
  2. resource_ar_n : string;
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Information for a tag associated with an 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.

type tag_info_for_resource = {
  1. tag_list : tag list option;
  2. resource_ar_n : string option;
}
type subscribed_rule_group_summary = {
  1. metric_name : string;
    (*

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.

    *)
  2. name : string;
    (*

    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.

    *)
  3. rule_group_id : string;
    (*

    A unique identifier for a RuleGroup.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A summary of the rule groups you are subscribed to.

type sql_injection_match_set_summary = {
  1. name : string;
    (*

    The name of the SqlInjectionMatchSet, if any, specified by Id.

    *)
  2. sql_injection_match_set_id : string;
    (*

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).

    SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The Id and Name of a SqlInjectionMatchSet.

type sql_injection_match_set = {
  1. sql_injection_match_tuples : sql_injection_match_tuple list;
    (*

    Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.

    *)
  2. name : string option;
    (*

    The name, if any, of the SqlInjectionMatchSet.

    *)
  3. sql_injection_match_set_id : string;
    (*

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).

    SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match.

type size_constraint_set_summary = {
  1. name : string;
    (*

    The name of the SizeConstraintSet, if any.

    *)
  2. size_constraint_set_id : string;
    (*

    A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

    SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The Id and Name of a SizeConstraintSet.

type size_constraint_set = {
  1. size_constraints : size_constraint list;
    (*

    Specifies the parts of web requests that you want to inspect the size of.

    *)
  2. name : string option;
    (*

    The name, if any, of the SizeConstraintSet.

    *)
  3. size_constraint_set_id : string;
    (*

    A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

    SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match.

type http_header = {
  1. value : string option;
    (*

    The value of one of the headers in the sampled web request.

    *)
  2. name : string option;
    (*

    The name of one of the headers in the sampled web request.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The response from a GetSampledRequests request includes an HTTPHeader complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests that were returned by GetSampledRequests.

type http_request = {
  1. headers : http_header list option;
    (*

    A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.

    *)
  2. http_version : string option;
    (*

    The HTTP version specified in the sampled web request, for example, HTTP/1.1.

    *)
  3. method_ : string option;
    (*

    The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

    *)
  4. ur_i : string option;
    (*

    The part of a web request that identifies the resource, for example, /images/daily-ad.jpg.

    *)
  5. country : string option;
    (*

    The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.

    *)
  6. client_i_p : string option;
    (*

    The IP address that the request originated from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

    • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
    • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request
    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The response from a GetSampledRequests request includes an HTTPRequest complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests that were returned by GetSampledRequests.

type sampled_http_request = {
  1. rule_within_rule_group : string option;
    (*

    This value is returned if the GetSampledRequests request specifies the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the specified RuleGroup that matched the request listed in the response.

    *)
  2. action : string option;
    (*

    The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.

    *)
  3. timestamp_ : float option;
    (*

    The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

    *)
  4. weight : int;
    (*

    A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1.

    *)
  5. request : http_request;
    (*

    A complex type that contains detailed information about the request.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The response from a GetSampledRequests request includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web request that is returned by GetSampledRequests.

type rule_summary = {
  1. name : string;
    (*

    A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    *)
  2. rule_id : string;
    (*

    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    RuleId is returned by CreateRule and by ListRules.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the friendly name or description of the Rule.

type rule_group_summary = {
  1. name : string;
    (*

    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.

    *)
  2. rule_group_id : string;
    (*

    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

    RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the friendly name or description of the RuleGroup.

type rule_group = {
  1. metric_name : string option;
    (*

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.

    *)
  2. name : string option;
    (*

    The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it.

    *)
  3. rule_group_id : string;
    (*

    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

    RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A collection of predefined rules that you can add to a web ACL.

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.
type rule = {
  1. predicates : predicate list;
    (*

    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

    *)
  2. metric_name : string option;
    (*

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

    *)
  3. name : string option;
    (*

    The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

    *)
  4. rule_id : string;
    (*

    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    RuleId is returned by CreateRule and by ListRules.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

  • An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44
  • A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot.

To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot.

type regex_pattern_set_summary = {
  1. name : string;
    (*

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    *)
  2. regex_pattern_set_id : string;
    (*

    The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

    RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returned by ListRegexPatternSets. Each RegexPatternSetSummary object includes the Name and RegexPatternSetId for one RegexPatternSet.

type regex_pattern_set = {
  1. regex_pattern_strings : string list;
    (*

    Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.

    *)
  2. name : string option;
    (*

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    *)
  3. regex_pattern_set_id : string;
    (*

    The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

    RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The RegexPatternSet specifies 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.

type regex_match_set_summary = {
  1. name : string;
    (*

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

    *)
  2. regex_match_set_id : string;
    (*

    The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet, update a RegexMatchSet, remove a RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF.

    RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returned by ListRegexMatchSets. Each RegexMatchSetSummary object includes the Name and RegexMatchSetId for one RegexMatchSet.

type regex_match_set = {
  1. regex_match_tuples : regex_match_tuple list option;
    (*

    Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:

    • 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 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.
    *)
  2. name : string option;
    (*

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

    *)
  3. regex_match_set_id : string option;
    (*

    The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).

    RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In a GetRegexMatchSet request, RegexMatchSet is a complex type that contains the RegexMatchSetId and Name of a RegexMatchSet, and the values that you specified when you updated the RegexMatchSet.

The values are contained in a RegexMatchTuple object, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a RegexMatchSet contains more than one RegexMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

type rate_key =
  1. | IP
type rate_based_rule = {
  1. rate_limit : int;
    (*

    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    *)
  2. rate_key : rate_key;
    (*

    The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

    *)
  3. match_predicates : predicate list;
    (*

    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

    *)
  4. metric_name : string option;
    (*

    A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

    *)
  5. name : string option;
    (*

    A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.

    *)
  6. rule_id : string;
    (*

    A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A RateBasedRule is identical to a regular Rule, with one addition: a RateBasedRule counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule that includes the following conditions:

  • The requests come from 192.0.2.44.
  • They contain the value BadBot in the User-Agent header.

In the rule, you also define the rate limit as 1,000.

Requests that meet both of these conditions and exceed 1,000 requests every five minutes trigger the rule's action (block or count), which is defined in the web ACL.

type put_permission_policy_response = unit
type put_permission_policy_request = {
  1. policy : string;
    (*

    The policy to attach to the specified RuleGroup.

    *)
  2. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

    *)
}
type logging_configuration = {
  1. redacted_fields : field_to_match list option;
    (*

    The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx.

    *)
  2. log_destination_configs : string list;
    (*

    An array of Amazon Kinesis Data Firehose ARNs.

    *)
  3. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The Amazon Kinesis Data Firehose, RedactedFields information, and the web ACL Amazon Resource Name (ARN).

type put_logging_configuration_response = {
  1. logging_configuration : logging_configuration option;
    (*

    The LoggingConfiguration that you submitted in the request.

    *)
}
type put_logging_configuration_request = {
  1. logging_configuration : logging_configuration;
    (*

    The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor.

    When specifying Type in RedactedFields, you must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.

    *)
}
type list_xss_match_sets_response = {
  1. xss_match_sets : xss_match_set_summary list option;
    (*

    An array of XssMatchSetSummary objects.

    *)
  2. next_marker : string option;
    (*

    If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}

The response to a ListXssMatchSets request.

type list_xss_match_sets_request = {
  1. limit : int option;
    (*

    Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets.

    *)
}

A request to list the XssMatchSet objects created by the current AWS account.

type list_web_ac_ls_response = {
  1. web_ac_ls : web_acl_summary list option;
    (*

    An array of WebACLSummary objects.

    *)
  2. next_marker : string option;
    (*

    If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}
type list_web_ac_ls_request = {
  1. limit : int option;
    (*

    Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects.

    *)
}
type list_tags_for_resource_response = {
  1. tag_info_for_resource : tag_info_for_resource option;
  2. next_marker : string option;
}
type list_tags_for_resource_request = {
  1. resource_ar_n : string;
  2. limit : int option;
  3. next_marker : string option;
}
type list_subscribed_rule_groups_response = {
  1. rule_groups : subscribed_rule_group_summary list option;
    (*

    An array of RuleGroup objects.

    *)
  2. next_marker : string option;
    (*

    If you have more objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more objects, submit another ListSubscribedRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}
type list_subscribed_rule_groups_request = {
  1. limit : int option;
    (*

    Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of objects.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker from the previous response to get information about another batch of subscribed rule groups.

    *)
}
type list_sql_injection_match_sets_response = {
  1. sql_injection_match_sets : sql_injection_match_set_summary list option;
    (*

    An array of SqlInjectionMatchSetSummary objects.

    *)
  2. next_marker : string option;
    (*

    If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}

The response to a ListSqlInjectionMatchSets request.

type list_sql_injection_match_sets_request = {
  1. limit : int option;
    (*

    Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets.

    *)
}

A request to list the SqlInjectionMatchSet objects created by the current AWS account.

type list_size_constraint_sets_response = {
  1. size_constraint_sets : size_constraint_set_summary list option;
    (*

    An array of SizeConstraintSetSummary objects.

    *)
  2. next_marker : string option;
    (*

    If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}
type list_size_constraint_sets_request = {
  1. limit : int option;
    (*

    Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets.

    *)
}
type list_rules_response = {
  1. rules : rule_summary list option;
    (*

    An array of RuleSummary objects.

    *)
  2. next_marker : string option;
    (*

    If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}
type list_rules_request = {
  1. limit : int option;
    (*

    Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

    *)
}
type list_rule_groups_response = {
  1. rule_groups : rule_group_summary list option;
    (*

    An array of RuleGroup objects.

    *)
  2. next_marker : string option;
    (*

    If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}
type list_rule_groups_request = {
  1. limit : int option;
    (*

    Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups.

    *)
}
type list_regex_pattern_sets_response = {
  1. regex_pattern_sets : regex_pattern_set_summary list option;
    (*

    An array of RegexPatternSetSummary objects.

    *)
  2. next_marker : string option;
    (*

    If you have more RegexPatternSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexPatternSet objects, submit another ListRegexPatternSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}
type list_regex_pattern_sets_request = {
  1. limit : int option;
    (*

    Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If you have more RegexPatternSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexPatternSet objects.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. For the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexPatternSet objects.

    *)
}
type list_regex_match_sets_response = {
  1. regex_match_sets : regex_match_set_summary list option;
    (*

    An array of RegexMatchSetSummary objects.

    *)
  2. next_marker : string option;
    (*

    If you have more RegexMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexMatchSet objects, submit another ListRegexMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}
type list_regex_match_sets_request = {
  1. limit : int option;
    (*

    Specifies the number of RegexMatchSet objects that you want AWS WAF to return for this request. If you have more RegexMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexMatchSet objects.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more RegexMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexMatchSet objects.

    *)
}
type list_rate_based_rules_response = {
  1. rules : rule_summary list option;
    (*

    An array of RuleSummary objects.

    *)
  2. next_marker : string option;
    (*

    If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}
type list_rate_based_rules_request = {
  1. limit : int option;
    (*

    Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

    *)
}
type list_logging_configurations_response = {
  1. next_marker : string option;
    (*

    If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
  2. logging_configurations : logging_configuration list option;
    (*

    An array of LoggingConfiguration objects.

    *)
}
type list_logging_configurations_request = {
  1. limit : int option;
    (*

    Specifies the number of LoggingConfigurations that you want AWS WAF to return for this request. If you have more LoggingConfigurations than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of LoggingConfigurations.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more LoggingConfigurations than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of LoggingConfigurations. For the second and subsequent ListLoggingConfigurations requests, specify the value of NextMarker from the previous response to get information about another batch of ListLoggingConfigurations.

    *)
}
type ip_set_summary = {
  1. name : string;
    (*

    A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

    *)
  2. ip_set_id : string;
    (*

    The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the name of the IPSet.

type list_ip_sets_response = {
  1. ip_sets : ip_set_summary list option;
    (*

    An array of IPSetSummary objects.

    *)
  2. next_marker : string option;
    (*

    To list more IPSet objects, submit another ListIPSets request, and in the next request use the NextMarker response value as the NextMarker value.

    *)
}
type list_ip_sets_request = {
  1. limit : int option;
    (*

    Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects.

    *)
  2. next_marker : string option;
    (*

    AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of IPSets.

    *)
}
type geo_match_set_summary = {
  1. name : string;
    (*

    A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.

    *)
  2. geo_match_set_id : string;
    (*

    The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a GetGeoMatchSet request to get detailed information about an GeoMatchSet.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the name of the GeoMatchSet.

type list_geo_match_sets_response = {
  1. geo_match_sets : geo_match_set_summary list option;
    (*

    An array of GeoMatchSetSummary objects.

    *)
  2. next_marker : string option;
    (*

    If you have more GeoMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}
type list_geo_match_sets_request = {
  1. limit : int option;
    (*

    Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more GeoMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of GeoMatchSet objects.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of GeoMatchSet objects.

    *)
}
type byte_match_set_summary = {
  1. name : string;
    (*

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    *)
  2. byte_match_set_id : string;
    (*

    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.

    ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returned by ListByteMatchSets. Each ByteMatchSetSummary object includes the Name and ByteMatchSetId for one ByteMatchSet.

type list_byte_match_sets_response = {
  1. byte_match_sets : byte_match_set_summary list option;
    (*

    An array of ByteMatchSetSummary objects.

    *)
  2. next_marker : string option;
    (*

    If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}
type list_byte_match_sets_request = {
  1. limit : int option;
    (*

    Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.

    *)
}
type list_activated_rules_in_rule_group_response = {
  1. activated_rules : activated_rule list option;
    (*

    An array of ActivatedRules objects.

    *)
  2. next_marker : string option;
    (*

    If you have more ActivatedRules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    *)
}
type list_activated_rules_in_rule_group_request = {
  1. limit : int option;
    (*

    Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ActivatedRules.

    *)
  2. next_marker : string option;
    (*

    If you specify a value for Limit and you have more ActivatedRules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous response to get information about another batch of ActivatedRules.

    *)
  3. rule_group_id : string option;
    (*

    The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.

    *)
}
type ip_set = {
  1. ip_set_descriptors : ip_set_descriptor list;
    (*

    The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.

    *)
  2. name : string option;
    (*

    A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

    *)
  3. ip_set_id : string;
    (*

    The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

    IPSetId is returned by CreateIPSet and by ListIPSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. 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.

To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

type get_xss_match_set_response = {
  1. xss_match_set : xss_match_set option;
    (*

    Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics:

    • XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects
    • XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation
    • FieldToMatch: Contains Data and Type
    *)
}

The response to a GetXssMatchSet request.

type get_xss_match_set_request = {
  1. xss_match_set_id : string;
    (*

    The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    *)
}

A request to get an XssMatchSet.

type get_web_acl_response = {
  1. web_ac_l : web_ac_l option;
    (*

    Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics:

    • WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId
    • DefaultAction (Data type is WafAction): Contains Type
    • Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId
    • Action: Contains Type
    *)
}
type get_web_acl_request = {
  1. web_acl_id : string;
    (*

    The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs.

    *)
}
type get_sql_injection_match_set_response = {
  1. sql_injection_match_set : sql_injection_match_set option;
    (*

    Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics:

    • SqlInjectionMatchSet: Contains Name, SqlInjectionMatchSetId, and an array of SqlInjectionMatchTuple objects
    • SqlInjectionMatchTuple: Each SqlInjectionMatchTuple object contains FieldToMatch and TextTransformation
    • FieldToMatch: Contains Data and Type
    *)
}

The response to a GetSqlInjectionMatchSet request.

type get_sql_injection_match_set_request = {
  1. sql_injection_match_set_id : string;
    (*

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    *)
}

A request to get a SqlInjectionMatchSet.

type get_size_constraint_set_response = {
  1. size_constraint_set : size_constraint_set option;
    (*

    Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics:

    • SizeConstraintSet: Contains SizeConstraintSetId, SizeConstraints, and Name
    • SizeConstraints: Contains an array of SizeConstraint objects. Each SizeConstraint object contains FieldToMatch, TextTransformation, ComparisonOperator, and Size
    • FieldToMatch: Contains Data and Type
    *)
}
type get_size_constraint_set_request = {
  1. size_constraint_set_id : string;
    (*

    The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    *)
}
type get_sampled_requests_response = {
  1. time_window : time_window option;
    (*

    Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

    *)
  2. population_size : int option;
    (*

    The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range.

    *)
  3. sampled_requests : sampled_http_request list option;
    (*

    A complex type that contains detailed information about each of the requests in the sample.

    *)
}
type get_sampled_requests_request = {
  1. max_items : int;
    (*

    The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

    *)
  2. time_window : time_window;
    (*

    The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

    *)
  3. rule_id : string;
    (*

    RuleId is one of three values:

    • The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests.
    • Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.
    *)
  4. web_acl_id : string;
    (*

    The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

    *)
}
type get_rule_response = {
  1. rule : rule option;
    (*

    Information about the Rule that you specified in the GetRule request. For more information, see the following topics:

    • Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId
    • Predicate: Each Predicate object contains DataId, Negated, and Type
    *)
}
type get_rule_request = {
  1. rule_id : string;
    (*

    The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.

    *)
}
type get_rule_group_response = {
  1. rule_group : rule_group option;
    (*

    Information about the RuleGroup that you specified in the GetRuleGroup request.

    *)
}
type get_rule_group_request = {
  1. rule_group_id : string;
    (*

    The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    *)
}
type get_regex_pattern_set_response = {
  1. regex_pattern_set : regex_pattern_set option;
    (*

    Information about the RegexPatternSet that you specified in the GetRegexPatternSet request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for.

    *)
}
type get_regex_pattern_set_request = {
  1. regex_pattern_set_id : string;
    (*

    The RegexPatternSetId of the RegexPatternSet that you want to get. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    *)
}
type get_regex_match_set_response = {
  1. regex_match_set : regex_match_set option;
    (*

    Information about the RegexMatchSet that you specified in the GetRegexMatchSet request. For more information, see RegexMatchTuple.

    *)
}
type get_regex_match_set_request = {
  1. regex_match_set_id : string;
    (*

    The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    *)
}
type get_rate_based_rule_response = {
  1. rule : rate_based_rule option;
    (*

    Information about the RateBasedRule that you specified in the GetRateBasedRule request.

    *)
}
type get_rate_based_rule_request = {
  1. rule_id : string;
    (*

    The RuleId of the RateBasedRule that you want to get. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    *)
}
type get_rate_based_rule_managed_keys_response = {
  1. next_marker : string option;
    (*

    A null value and not currently used.

    *)
  2. managed_keys : string list option;
    (*

    An array of IP addresses that currently are blocked by the specified RateBasedRule.

    *)
}
type get_rate_based_rule_managed_keys_request = {
  1. next_marker : string option;
    (*

    A null value and not currently used. Do not include this in your request.

    *)
  2. rule_id : string;
    (*

    The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    *)
}
type get_permission_policy_response = {
  1. policy : string option;
    (*

    The IAM policy attached to the specified RuleGroup.

    *)
}
type get_permission_policy_request = {
  1. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy.

    *)
}
type get_logging_configuration_response = {
  1. logging_configuration : logging_configuration option;
    (*

    The LoggingConfiguration for the specified web ACL.

    *)
}
type get_logging_configuration_request = {
  1. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

    *)
}
type get_ip_set_response = {
  1. ip_set : ip_set option;
    (*

    Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics:

    • IPSet: Contains IPSetDescriptors, IPSetId, and Name
    • IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value
    *)
}
type get_ip_set_request = {
  1. ip_set_id : string;
    (*

    The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.

    *)
}
type geo_match_set = {
  1. geo_match_constraints : geo_match_constraint list;
    (*

    An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.

    *)
  2. name : string option;
    (*

    A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.

    *)
  3. geo_match_set_id : string;
    (*

    The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet).

    GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains one or more countries that AWS WAF will search for.

type get_geo_match_set_response = {
  1. geo_match_set : geo_match_set option;
    (*

    Information about the GeoMatchSet that you specified in the GetGeoMatchSet request. This includes the Type, which for a GeoMatchContraint is always Country, as well as the Value, which is the identifier for a specific country.

    *)
}
type get_geo_match_set_request = {
  1. geo_match_set_id : string;
    (*

    The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    *)
}
type change_token_status =
  1. | INSYNC
  2. | PENDING
  3. | PROVISIONED
type get_change_token_status_response = {
  1. change_token_status : change_token_status option;
    (*

    The status of the change token.

    *)
}
type get_change_token_status_request = {
  1. change_token : string;
    (*

    The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.

    *)
}
type get_change_token_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.

    *)
}
type get_change_token_request = unit
type byte_match_set = {
  1. byte_match_tuples : byte_match_tuple list;
    (*

    Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

    *)
  2. name : string option;
    (*

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    *)
  3. byte_match_set_id : string;
    (*

    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

    ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you specified when you updated the ByteMatchSet.

A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

type get_byte_match_set_response = {
  1. byte_match_set : byte_match_set option;
    (*

    Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics:

    • ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name
    • ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation
    • FieldToMatch: Contains Data and Type
    *)
}
type get_byte_match_set_request = {
  1. byte_match_set_id : string;
    (*

    The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    *)
}
type delete_xss_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}

The response to a request to delete an XssMatchSet from AWS WAF.

type delete_xss_match_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. xss_match_set_id : string;
    (*

    The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    *)
}

A request to delete an XssMatchSet from AWS WAF.

type delete_web_acl_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type delete_web_acl_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. web_acl_id : string;
    (*

    The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs.

    *)
}
type delete_sql_injection_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}

The response to a request to delete a SqlInjectionMatchSet from AWS WAF.

type delete_sql_injection_match_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. sql_injection_match_set_id : string;
    (*

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    *)
}

A request to delete a SqlInjectionMatchSet from AWS WAF.

type delete_size_constraint_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type delete_size_constraint_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. size_constraint_set_id : string;
    (*

    The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    *)
}
type delete_rule_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type delete_rule_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. rule_id : string;
    (*

    The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.

    *)
}
type delete_rule_group_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type delete_rule_group_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. rule_group_id : string;
    (*

    The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    *)
}
type delete_regex_pattern_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the DeleteRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type delete_regex_pattern_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. regex_pattern_set_id : string;
    (*

    The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    *)
}
type delete_regex_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type delete_regex_match_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. regex_match_set_id : string;
    (*

    The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    *)
}
type delete_rate_based_rule_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type delete_rate_based_rule_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. rule_id : string;
    (*

    The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    *)
}
type delete_permission_policy_response = unit
type delete_permission_policy_request = {
  1. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy.

    The user making the request must be the owner of the RuleGroup.

    *)
}
type delete_logging_configuration_response = unit
type delete_logging_configuration_request = {
  1. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.

    *)
}
type delete_ip_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type delete_ip_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. ip_set_id : string;
    (*

    The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.

    *)
}
type delete_geo_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type delete_geo_match_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. geo_match_set_id : string;
    (*

    The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    *)
}
type delete_byte_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
}
type delete_byte_match_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. byte_match_set_id : string;
    (*

    The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    *)
}
type create_xss_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  2. xss_match_set : xss_match_set option;
    (*

    An XssMatchSet.

    *)
}

The response to a CreateXssMatchSet request.

type create_xss_match_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. name : string;
    (*

    A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.

    *)
}

A request to create an XssMatchSet.

type create_web_acl_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  2. web_ac_l : web_ac_l option;
    (*

    The WebACL returned in the CreateWebACL response.

    *)
}
type create_web_acl_request = {
  1. tags : tag list option;
  2. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  3. default_action : waf_action;
    (*

    The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.

    *)
  4. metric_name : string;
    (*

    A friendly name or description for the metrics for this WebACL.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL.

    *)
  5. name : string;
    (*

    A friendly name or description of the WebACL. You can't change Name after you create the WebACL.

    *)
}
type create_web_acl_migration_stack_response = {
  1. s3_object_url : string;
    (*

    The URL of the template created in Amazon S3.

    *)
}
type create_web_acl_migration_stack_request = {
  1. ignore_unsupported_type : bool;
    (*

    Indicates whether to exclude entities that can't be migrated or to stop the migration. Set this to true to ignore unsupported entities in the web ACL during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the process and throws an exception.

    *)
  2. s3_bucket_name : string;
    (*

    The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 bucket must be configured as follows for the migration:

    • The bucket name must start with aws-waf-migration-. For example, aws-waf-migration-my-web-acl.
    • The bucket must be in the Region where you are deploying the template. For example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template stack to us-west-2.
    • The bucket policies must permit the migration process to write data. For listings of the bucket policies, see the Examples section.
    *)
  3. web_acl_id : string;
    (*

    The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.

    *)
}
type create_sql_injection_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  2. sql_injection_match_set : sql_injection_match_set option;
    (*

    A SqlInjectionMatchSet.

    *)
}

The response to a CreateSqlInjectionMatchSet request.

type create_sql_injection_match_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. name : string;
    (*

    A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet.

    *)
}

A request to create a SqlInjectionMatchSet.

type create_size_constraint_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  2. size_constraint_set : size_constraint_set option;
    (*

    A SizeConstraintSet that contains no SizeConstraint objects.

    *)
}
type create_size_constraint_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. name : string;
    (*

    A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet.

    *)
}
type create_rule_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  2. rule : rule option;
    (*

    The Rule returned in the CreateRule response.

    *)
}
type create_rule_request = {
  1. tags : tag list option;
  2. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  3. metric_name : string;
    (*

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the Rule.

    *)
  4. name : string;
    (*

    A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    *)
}
type create_rule_group_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the CreateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  2. rule_group : rule_group option;
    (*

    An empty RuleGroup.

    *)
}
type create_rule_group_request = {
  1. tags : tag list option;
  2. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  3. metric_name : string;
    (*

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.

    *)
  4. name : string;
    (*

    A friendly name or description of the RuleGroup. You can't change Name after you create a RuleGroup.

    *)
}
type create_regex_pattern_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  2. regex_pattern_set : regex_pattern_set option;
    (*

    A RegexPatternSet that contains no objects.

    *)
}
type create_regex_pattern_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. name : string;
    (*

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    *)
}
type create_regex_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  2. regex_match_set : regex_match_set option;
    (*

    A RegexMatchSet that contains no RegexMatchTuple objects.

    *)
}
type create_regex_match_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. name : string;
    (*

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

    *)
}
type create_rate_based_rule_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  2. rule : rate_based_rule option;
    (*

    The RateBasedRule that is returned in the CreateRateBasedRule response.

    *)
}
type create_rate_based_rule_request = {
  1. tags : tag list option;
  2. change_token : string;
    (*

    The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  3. rate_limit : int;
    (*

    The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    *)
  4. rate_key : rate_key;
    (*

    The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

    *)
  5. metric_name : string;
    (*

    A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

    *)
  6. name : string;
    (*

    A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it.

    *)
}
type create_ip_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  2. ip_set : ip_set option;
    (*

    The IPSet returned in the CreateIPSet response.

    *)
}
type create_ip_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. name : string;
    (*

    A friendly name or description of the IPSet. You can't change Name after you create the IPSet.

    *)
}
type create_geo_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the CreateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  2. geo_match_set : geo_match_set option;
    (*

    The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints.

    *)
}
type create_geo_match_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. name : string;
    (*

    A friendly name or description of the GeoMatchSet. You can't change Name after you create the GeoMatchSet.

    *)
}
type create_byte_match_set_response = {
  1. change_token : string option;
    (*

    The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    *)
  2. byte_match_set : byte_match_set option;
    (*

    A ByteMatchSet that contains no ByteMatchTuple objects.

    *)
}
type create_byte_match_set_request = {
  1. change_token : string;
    (*

    The value returned by the most recent call to GetChangeToken.

    *)
  2. name : string;
    (*

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    *)
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

This is the AWS WAF Classic API Reference for using AWS WAF Classic with Amazon CloudFront. The AWS WAF Classic actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. 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 in the developer guide.

type base_document = Smaws_Lib.Json.t

Builders

val make_field_to_match : ?data:string -> type_:match_field_type -> unit -> field_to_match

Create a field_to_match type

val make_xss_match_tuple : text_transformation:text_transformation -> field_to_match:field_to_match -> unit -> xss_match_tuple

Create a xss_match_tuple type

val make_xss_match_set_update : xss_match_tuple:xss_match_tuple -> action:change_action -> unit -> xss_match_set_update

Create a xss_match_set_update type

val make_xss_match_set_summary : name:string -> xss_match_set_id:string -> unit -> xss_match_set_summary

Create a xss_match_set_summary type

val make_xss_match_set : ?name:string -> xss_match_tuples:xss_match_tuple list -> xss_match_set_id:string -> unit -> xss_match_set

Create a xss_match_set type

val make_waf_action : type_:waf_action_type -> unit -> waf_action

Create a waf_action type

val make_waf_override_action : type_:waf_override_action_type -> unit -> waf_override_action

Create a waf_override_action type

val make_excluded_rule : rule_id:string -> unit -> excluded_rule

Create a excluded_rule type

val make_activated_rule : ?excluded_rules:excluded_rule list -> ?type_:waf_rule_type -> ?override_action:waf_override_action -> ?action:waf_action -> rule_id:string -> priority:int -> unit -> activated_rule

Create a activated_rule type

val make_web_acl_update : activated_rule:activated_rule -> action:change_action -> unit -> web_acl_update

Create a web_acl_update type

val make_web_acl_summary : name:string -> web_acl_id:string -> unit -> web_acl_summary

Create a web_acl_summary type

val make_web_ac_l : ?web_acl_arn:string -> ?metric_name:string -> ?name:string -> rules:activated_rule list -> default_action:waf_action -> web_acl_id:string -> unit -> web_ac_l

Create a web_ac_l type

val make_update_xss_match_set_response : ?change_token:string -> unit -> update_xss_match_set_response

Create a update_xss_match_set_response type

val make_update_xss_match_set_request : updates:xss_match_set_update list -> change_token:string -> xss_match_set_id:string -> unit -> update_xss_match_set_request

Create a update_xss_match_set_request type

val make_update_web_acl_response : ?change_token:string -> unit -> update_web_acl_response

Create a update_web_acl_response type

val make_update_web_acl_request : ?default_action:waf_action -> ?updates:web_acl_update list -> change_token:string -> web_acl_id:string -> unit -> update_web_acl_request

Create a update_web_acl_request type

val make_update_sql_injection_match_set_response : ?change_token:string -> unit -> update_sql_injection_match_set_response

Create a update_sql_injection_match_set_response type

val make_sql_injection_match_tuple : text_transformation:text_transformation -> field_to_match:field_to_match -> unit -> sql_injection_match_tuple

Create a sql_injection_match_tuple type

val make_sql_injection_match_set_update : sql_injection_match_tuple:sql_injection_match_tuple -> action:change_action -> unit -> sql_injection_match_set_update

Create a sql_injection_match_set_update type

val make_update_sql_injection_match_set_request : updates:sql_injection_match_set_update list -> change_token:string -> sql_injection_match_set_id:string -> unit -> update_sql_injection_match_set_request

Create a update_sql_injection_match_set_request type

val make_update_size_constraint_set_response : ?change_token:string -> unit -> update_size_constraint_set_response

Create a update_size_constraint_set_response type

val make_size_constraint : size:int -> comparison_operator:comparison_operator -> text_transformation:text_transformation -> field_to_match:field_to_match -> unit -> size_constraint

Create a size_constraint type

val make_size_constraint_set_update : size_constraint:size_constraint -> action:change_action -> unit -> size_constraint_set_update

Create a size_constraint_set_update type

val make_update_size_constraint_set_request : updates:size_constraint_set_update list -> change_token:string -> size_constraint_set_id:string -> unit -> update_size_constraint_set_request

Create a update_size_constraint_set_request type

val make_update_rule_response : ?change_token:string -> unit -> update_rule_response

Create a update_rule_response type

val make_predicate : data_id:string -> type_:predicate_type -> negated:bool -> unit -> predicate

Create a predicate type

val make_rule_update : predicate:predicate -> action:change_action -> unit -> rule_update

Create a rule_update type

val make_update_rule_request : updates:rule_update list -> change_token:string -> rule_id:string -> unit -> update_rule_request

Create a update_rule_request type

val make_update_rule_group_response : ?change_token:string -> unit -> update_rule_group_response

Create a update_rule_group_response type

val make_rule_group_update : activated_rule:activated_rule -> action:change_action -> unit -> rule_group_update

Create a rule_group_update type

val make_update_rule_group_request : change_token:string -> updates:rule_group_update list -> rule_group_id:string -> unit -> update_rule_group_request

Create a update_rule_group_request type

val make_update_regex_pattern_set_response : ?change_token:string -> unit -> update_regex_pattern_set_response

Create a update_regex_pattern_set_response type

val make_regex_pattern_set_update : regex_pattern_string:string -> action:change_action -> unit -> regex_pattern_set_update

Create a regex_pattern_set_update type

val make_update_regex_pattern_set_request : change_token:string -> updates:regex_pattern_set_update list -> regex_pattern_set_id:string -> unit -> update_regex_pattern_set_request

Create a update_regex_pattern_set_request type

val make_update_regex_match_set_response : ?change_token:string -> unit -> update_regex_match_set_response

Create a update_regex_match_set_response type

val make_regex_match_tuple : regex_pattern_set_id:string -> text_transformation:text_transformation -> field_to_match:field_to_match -> unit -> regex_match_tuple

Create a regex_match_tuple type

val make_regex_match_set_update : regex_match_tuple:regex_match_tuple -> action:change_action -> unit -> regex_match_set_update

Create a regex_match_set_update type

val make_update_regex_match_set_request : change_token:string -> updates:regex_match_set_update list -> regex_match_set_id:string -> unit -> update_regex_match_set_request

Create a update_regex_match_set_request type

val make_update_rate_based_rule_response : ?change_token:string -> unit -> update_rate_based_rule_response

Create a update_rate_based_rule_response type

val make_update_rate_based_rule_request : rate_limit:int -> updates:rule_update list -> change_token:string -> rule_id:string -> unit -> update_rate_based_rule_request

Create a update_rate_based_rule_request type

val make_update_ip_set_response : ?change_token:string -> unit -> update_ip_set_response

Create a update_ip_set_response type

val make_ip_set_descriptor : value:string -> type_:ip_set_descriptor_type -> unit -> ip_set_descriptor

Create a ip_set_descriptor type

val make_ip_set_update : ip_set_descriptor:ip_set_descriptor -> action:change_action -> unit -> ip_set_update

Create a ip_set_update type

val make_update_ip_set_request : updates:ip_set_update list -> change_token:string -> ip_set_id:string -> unit -> update_ip_set_request

Create a update_ip_set_request type

val make_update_geo_match_set_response : ?change_token:string -> unit -> update_geo_match_set_response

Create a update_geo_match_set_response type

val make_geo_match_constraint : value:geo_match_constraint_value -> type_:geo_match_constraint_type -> unit -> geo_match_constraint

Create a geo_match_constraint type

val make_geo_match_set_update : geo_match_constraint:geo_match_constraint -> action:change_action -> unit -> geo_match_set_update

Create a geo_match_set_update type

val make_update_geo_match_set_request : updates:geo_match_set_update list -> change_token:string -> geo_match_set_id:string -> unit -> update_geo_match_set_request

Create a update_geo_match_set_request type

val make_update_byte_match_set_response : ?change_token:string -> unit -> update_byte_match_set_response

Create a update_byte_match_set_response type

val make_byte_match_tuple : positional_constraint:positional_constraint -> text_transformation:text_transformation -> target_string:bytes -> field_to_match:field_to_match -> unit -> byte_match_tuple

Create a byte_match_tuple type

val make_byte_match_set_update : byte_match_tuple:byte_match_tuple -> action:change_action -> unit -> byte_match_set_update

Create a byte_match_set_update type

val make_update_byte_match_set_request : updates:byte_match_set_update list -> change_token:string -> byte_match_set_id:string -> unit -> update_byte_match_set_request

Create a update_byte_match_set_request type

val make_untag_resource_response : unit -> untag_resource_response

Create a untag_resource_response type

val make_untag_resource_request : tag_keys:string list -> resource_ar_n:string -> unit -> untag_resource_request

Create a untag_resource_request type

val make_time_window : end_time:float -> start_time:float -> unit -> time_window

Create a time_window type

val make_tag_resource_response : unit -> tag_resource_response

Create a tag_resource_response type

val make_tag : value:string -> key:string -> unit -> tag

Create a tag type

val make_tag_resource_request : tags:tag list -> resource_ar_n:string -> unit -> tag_resource_request

Create a tag_resource_request type

val make_tag_info_for_resource : ?tag_list:tag list -> ?resource_ar_n:string -> unit -> tag_info_for_resource

Create a tag_info_for_resource type

val make_subscribed_rule_group_summary : metric_name:string -> name:string -> rule_group_id:string -> unit -> subscribed_rule_group_summary

Create a subscribed_rule_group_summary type

val make_sql_injection_match_set_summary : name:string -> sql_injection_match_set_id:string -> unit -> sql_injection_match_set_summary

Create a sql_injection_match_set_summary type

val make_sql_injection_match_set : ?name:string -> sql_injection_match_tuples:sql_injection_match_tuple list -> sql_injection_match_set_id:string -> unit -> sql_injection_match_set

Create a sql_injection_match_set type

val make_size_constraint_set_summary : name:string -> size_constraint_set_id:string -> unit -> size_constraint_set_summary

Create a size_constraint_set_summary type

val make_size_constraint_set : ?name:string -> size_constraints:size_constraint list -> size_constraint_set_id:string -> unit -> size_constraint_set

Create a size_constraint_set type

val make_http_header : ?value:string -> ?name:string -> unit -> http_header

Create a http_header type

val make_http_request : ?headers:http_header list -> ?http_version:string -> ?method_:string -> ?ur_i:string -> ?country:string -> ?client_i_p:string -> unit -> http_request

Create a http_request type

val make_sampled_http_request : ?rule_within_rule_group:string -> ?action:string -> ?timestamp_:float -> weight:int -> request:http_request -> unit -> sampled_http_request

Create a sampled_http_request type

val make_rule_summary : name:string -> rule_id:string -> unit -> rule_summary

Create a rule_summary type

val make_rule_group_summary : name:string -> rule_group_id:string -> unit -> rule_group_summary

Create a rule_group_summary type

val make_rule_group : ?metric_name:string -> ?name:string -> rule_group_id:string -> unit -> rule_group

Create a rule_group type

val make_rule : ?metric_name:string -> ?name:string -> predicates:predicate list -> rule_id:string -> unit -> rule

Create a rule type

val make_regex_pattern_set_summary : name:string -> regex_pattern_set_id:string -> unit -> regex_pattern_set_summary

Create a regex_pattern_set_summary type

val make_regex_pattern_set : ?name:string -> regex_pattern_strings:string list -> regex_pattern_set_id:string -> unit -> regex_pattern_set

Create a regex_pattern_set type

val make_regex_match_set_summary : name:string -> regex_match_set_id:string -> unit -> regex_match_set_summary

Create a regex_match_set_summary type

val make_regex_match_set : ?regex_match_tuples:regex_match_tuple list -> ?name:string -> ?regex_match_set_id:string -> unit -> regex_match_set

Create a regex_match_set type

val make_rate_based_rule : ?metric_name:string -> ?name:string -> rate_limit:int -> rate_key:rate_key -> match_predicates:predicate list -> rule_id:string -> unit -> rate_based_rule

Create a rate_based_rule type

val make_put_permission_policy_response : unit -> put_permission_policy_response

Create a put_permission_policy_response type

val make_put_permission_policy_request : policy:string -> resource_arn:string -> unit -> put_permission_policy_request

Create a put_permission_policy_request type

val make_logging_configuration : ?redacted_fields:field_to_match list -> log_destination_configs:string list -> resource_arn:string -> unit -> logging_configuration

Create a logging_configuration type

val make_put_logging_configuration_response : ?logging_configuration:logging_configuration -> unit -> put_logging_configuration_response

Create a put_logging_configuration_response type

val make_put_logging_configuration_request : logging_configuration:logging_configuration -> unit -> put_logging_configuration_request

Create a put_logging_configuration_request type

val make_list_xss_match_sets_response : ?xss_match_sets:xss_match_set_summary list -> ?next_marker:string -> unit -> list_xss_match_sets_response

Create a list_xss_match_sets_response type

val make_list_xss_match_sets_request : ?limit:int -> ?next_marker:string -> unit -> list_xss_match_sets_request

Create a list_xss_match_sets_request type

val make_list_web_ac_ls_response : ?web_ac_ls:web_acl_summary list -> ?next_marker:string -> unit -> list_web_ac_ls_response

Create a list_web_ac_ls_response type

val make_list_web_ac_ls_request : ?limit:int -> ?next_marker:string -> unit -> list_web_ac_ls_request

Create a list_web_ac_ls_request type

val make_list_tags_for_resource_response : ?tag_info_for_resource:tag_info_for_resource -> ?next_marker:string -> unit -> list_tags_for_resource_response

Create a list_tags_for_resource_response type

val make_list_tags_for_resource_request : ?limit:int -> ?next_marker:string -> resource_ar_n:string -> unit -> list_tags_for_resource_request

Create a list_tags_for_resource_request type

val make_list_subscribed_rule_groups_response : ?rule_groups:subscribed_rule_group_summary list -> ?next_marker:string -> unit -> list_subscribed_rule_groups_response

Create a list_subscribed_rule_groups_response type

val make_list_subscribed_rule_groups_request : ?limit:int -> ?next_marker:string -> unit -> list_subscribed_rule_groups_request

Create a list_subscribed_rule_groups_request type

val make_list_sql_injection_match_sets_response : ?sql_injection_match_sets:sql_injection_match_set_summary list -> ?next_marker:string -> unit -> list_sql_injection_match_sets_response

Create a list_sql_injection_match_sets_response type

val make_list_sql_injection_match_sets_request : ?limit:int -> ?next_marker:string -> unit -> list_sql_injection_match_sets_request

Create a list_sql_injection_match_sets_request type

val make_list_size_constraint_sets_response : ?size_constraint_sets:size_constraint_set_summary list -> ?next_marker:string -> unit -> list_size_constraint_sets_response

Create a list_size_constraint_sets_response type

val make_list_size_constraint_sets_request : ?limit:int -> ?next_marker:string -> unit -> list_size_constraint_sets_request

Create a list_size_constraint_sets_request type

val make_list_rules_response : ?rules:rule_summary list -> ?next_marker:string -> unit -> list_rules_response

Create a list_rules_response type

val make_list_rules_request : ?limit:int -> ?next_marker:string -> unit -> list_rules_request

Create a list_rules_request type

val make_list_rule_groups_response : ?rule_groups:rule_group_summary list -> ?next_marker:string -> unit -> list_rule_groups_response

Create a list_rule_groups_response type

val make_list_rule_groups_request : ?limit:int -> ?next_marker:string -> unit -> list_rule_groups_request

Create a list_rule_groups_request type

val make_list_regex_pattern_sets_response : ?regex_pattern_sets:regex_pattern_set_summary list -> ?next_marker:string -> unit -> list_regex_pattern_sets_response

Create a list_regex_pattern_sets_response type

val make_list_regex_pattern_sets_request : ?limit:int -> ?next_marker:string -> unit -> list_regex_pattern_sets_request

Create a list_regex_pattern_sets_request type

val make_list_regex_match_sets_response : ?regex_match_sets:regex_match_set_summary list -> ?next_marker:string -> unit -> list_regex_match_sets_response

Create a list_regex_match_sets_response type

val make_list_regex_match_sets_request : ?limit:int -> ?next_marker:string -> unit -> list_regex_match_sets_request

Create a list_regex_match_sets_request type

val make_list_rate_based_rules_response : ?rules:rule_summary list -> ?next_marker:string -> unit -> list_rate_based_rules_response

Create a list_rate_based_rules_response type

val make_list_rate_based_rules_request : ?limit:int -> ?next_marker:string -> unit -> list_rate_based_rules_request

Create a list_rate_based_rules_request type

val make_list_logging_configurations_response : ?next_marker:string -> ?logging_configurations:logging_configuration list -> unit -> list_logging_configurations_response

Create a list_logging_configurations_response type

val make_list_logging_configurations_request : ?limit:int -> ?next_marker:string -> unit -> list_logging_configurations_request

Create a list_logging_configurations_request type

val make_ip_set_summary : name:string -> ip_set_id:string -> unit -> ip_set_summary

Create a ip_set_summary type

val make_list_ip_sets_response : ?ip_sets:ip_set_summary list -> ?next_marker:string -> unit -> list_ip_sets_response

Create a list_ip_sets_response type

val make_list_ip_sets_request : ?limit:int -> ?next_marker:string -> unit -> list_ip_sets_request

Create a list_ip_sets_request type

val make_geo_match_set_summary : name:string -> geo_match_set_id:string -> unit -> geo_match_set_summary

Create a geo_match_set_summary type

val make_list_geo_match_sets_response : ?geo_match_sets:geo_match_set_summary list -> ?next_marker:string -> unit -> list_geo_match_sets_response

Create a list_geo_match_sets_response type

val make_list_geo_match_sets_request : ?limit:int -> ?next_marker:string -> unit -> list_geo_match_sets_request

Create a list_geo_match_sets_request type

val make_byte_match_set_summary : name:string -> byte_match_set_id:string -> unit -> byte_match_set_summary

Create a byte_match_set_summary type

val make_list_byte_match_sets_response : ?byte_match_sets:byte_match_set_summary list -> ?next_marker:string -> unit -> list_byte_match_sets_response

Create a list_byte_match_sets_response type

val make_list_byte_match_sets_request : ?limit:int -> ?next_marker:string -> unit -> list_byte_match_sets_request

Create a list_byte_match_sets_request type

val make_list_activated_rules_in_rule_group_response : ?activated_rules:activated_rule list -> ?next_marker:string -> unit -> list_activated_rules_in_rule_group_response

Create a list_activated_rules_in_rule_group_response type

val make_list_activated_rules_in_rule_group_request : ?limit:int -> ?next_marker:string -> ?rule_group_id:string -> unit -> list_activated_rules_in_rule_group_request

Create a list_activated_rules_in_rule_group_request type

val make_ip_set : ?name:string -> ip_set_descriptors:ip_set_descriptor list -> ip_set_id:string -> unit -> ip_set

Create a ip_set type

val make_get_xss_match_set_response : ?xss_match_set:xss_match_set -> unit -> get_xss_match_set_response

Create a get_xss_match_set_response type

val make_get_xss_match_set_request : xss_match_set_id:string -> unit -> get_xss_match_set_request

Create a get_xss_match_set_request type

val make_get_web_acl_response : ?web_ac_l:web_ac_l -> unit -> get_web_acl_response

Create a get_web_acl_response type

val make_get_web_acl_request : web_acl_id:string -> unit -> get_web_acl_request

Create a get_web_acl_request type

val make_get_sql_injection_match_set_response : ?sql_injection_match_set:sql_injection_match_set -> unit -> get_sql_injection_match_set_response

Create a get_sql_injection_match_set_response type

val make_get_sql_injection_match_set_request : sql_injection_match_set_id:string -> unit -> get_sql_injection_match_set_request

Create a get_sql_injection_match_set_request type

val make_get_size_constraint_set_response : ?size_constraint_set:size_constraint_set -> unit -> get_size_constraint_set_response

Create a get_size_constraint_set_response type

val make_get_size_constraint_set_request : size_constraint_set_id:string -> unit -> get_size_constraint_set_request

Create a get_size_constraint_set_request type

val make_get_sampled_requests_response : ?time_window:time_window -> ?population_size:int -> ?sampled_requests:sampled_http_request list -> unit -> get_sampled_requests_response

Create a get_sampled_requests_response type

val make_get_sampled_requests_request : max_items:int -> time_window:time_window -> rule_id:string -> web_acl_id:string -> unit -> get_sampled_requests_request

Create a get_sampled_requests_request type

val make_get_rule_response : ?rule:rule -> unit -> get_rule_response

Create a get_rule_response type

val make_get_rule_request : rule_id:string -> unit -> get_rule_request

Create a get_rule_request type

val make_get_rule_group_response : ?rule_group:rule_group -> unit -> get_rule_group_response

Create a get_rule_group_response type

val make_get_rule_group_request : rule_group_id:string -> unit -> get_rule_group_request

Create a get_rule_group_request type

val make_get_regex_pattern_set_response : ?regex_pattern_set:regex_pattern_set -> unit -> get_regex_pattern_set_response

Create a get_regex_pattern_set_response type

val make_get_regex_pattern_set_request : regex_pattern_set_id:string -> unit -> get_regex_pattern_set_request

Create a get_regex_pattern_set_request type

val make_get_regex_match_set_response : ?regex_match_set:regex_match_set -> unit -> get_regex_match_set_response

Create a get_regex_match_set_response type

val make_get_regex_match_set_request : regex_match_set_id:string -> unit -> get_regex_match_set_request

Create a get_regex_match_set_request type

val make_get_rate_based_rule_response : ?rule:rate_based_rule -> unit -> get_rate_based_rule_response

Create a get_rate_based_rule_response type

val make_get_rate_based_rule_request : rule_id:string -> unit -> get_rate_based_rule_request

Create a get_rate_based_rule_request type

val make_get_rate_based_rule_managed_keys_response : ?next_marker:string -> ?managed_keys:string list -> unit -> get_rate_based_rule_managed_keys_response

Create a get_rate_based_rule_managed_keys_response type

val make_get_rate_based_rule_managed_keys_request : ?next_marker:string -> rule_id:string -> unit -> get_rate_based_rule_managed_keys_request

Create a get_rate_based_rule_managed_keys_request type

val make_get_permission_policy_response : ?policy:string -> unit -> get_permission_policy_response

Create a get_permission_policy_response type

val make_get_permission_policy_request : resource_arn:string -> unit -> get_permission_policy_request

Create a get_permission_policy_request type

val make_get_logging_configuration_response : ?logging_configuration:logging_configuration -> unit -> get_logging_configuration_response

Create a get_logging_configuration_response type

val make_get_logging_configuration_request : resource_arn:string -> unit -> get_logging_configuration_request

Create a get_logging_configuration_request type

val make_get_ip_set_response : ?ip_set:ip_set -> unit -> get_ip_set_response

Create a get_ip_set_response type

val make_get_ip_set_request : ip_set_id:string -> unit -> get_ip_set_request

Create a get_ip_set_request type

val make_geo_match_set : ?name:string -> geo_match_constraints:geo_match_constraint list -> geo_match_set_id:string -> unit -> geo_match_set

Create a geo_match_set type

val make_get_geo_match_set_response : ?geo_match_set:geo_match_set -> unit -> get_geo_match_set_response

Create a get_geo_match_set_response type

val make_get_geo_match_set_request : geo_match_set_id:string -> unit -> get_geo_match_set_request

Create a get_geo_match_set_request type

val make_get_change_token_status_response : ?change_token_status:change_token_status -> unit -> get_change_token_status_response

Create a get_change_token_status_response type

val make_get_change_token_status_request : change_token:string -> unit -> get_change_token_status_request

Create a get_change_token_status_request type

val make_get_change_token_response : ?change_token:string -> unit -> get_change_token_response

Create a get_change_token_response type

val make_get_change_token_request : unit -> get_change_token_request

Create a get_change_token_request type

val make_byte_match_set : ?name:string -> byte_match_tuples:byte_match_tuple list -> byte_match_set_id:string -> unit -> byte_match_set

Create a byte_match_set type

val make_get_byte_match_set_response : ?byte_match_set:byte_match_set -> unit -> get_byte_match_set_response

Create a get_byte_match_set_response type

val make_get_byte_match_set_request : byte_match_set_id:string -> unit -> get_byte_match_set_request

Create a get_byte_match_set_request type

val make_delete_xss_match_set_response : ?change_token:string -> unit -> delete_xss_match_set_response

Create a delete_xss_match_set_response type

val make_delete_xss_match_set_request : change_token:string -> xss_match_set_id:string -> unit -> delete_xss_match_set_request

Create a delete_xss_match_set_request type

val make_delete_web_acl_response : ?change_token:string -> unit -> delete_web_acl_response

Create a delete_web_acl_response type

val make_delete_web_acl_request : change_token:string -> web_acl_id:string -> unit -> delete_web_acl_request

Create a delete_web_acl_request type

val make_delete_sql_injection_match_set_response : ?change_token:string -> unit -> delete_sql_injection_match_set_response

Create a delete_sql_injection_match_set_response type

val make_delete_sql_injection_match_set_request : change_token:string -> sql_injection_match_set_id:string -> unit -> delete_sql_injection_match_set_request

Create a delete_sql_injection_match_set_request type

val make_delete_size_constraint_set_response : ?change_token:string -> unit -> delete_size_constraint_set_response

Create a delete_size_constraint_set_response type

val make_delete_size_constraint_set_request : change_token:string -> size_constraint_set_id:string -> unit -> delete_size_constraint_set_request

Create a delete_size_constraint_set_request type

val make_delete_rule_response : ?change_token:string -> unit -> delete_rule_response

Create a delete_rule_response type

val make_delete_rule_request : change_token:string -> rule_id:string -> unit -> delete_rule_request

Create a delete_rule_request type

val make_delete_rule_group_response : ?change_token:string -> unit -> delete_rule_group_response

Create a delete_rule_group_response type

val make_delete_rule_group_request : change_token:string -> rule_group_id:string -> unit -> delete_rule_group_request

Create a delete_rule_group_request type

val make_delete_regex_pattern_set_response : ?change_token:string -> unit -> delete_regex_pattern_set_response

Create a delete_regex_pattern_set_response type

val make_delete_regex_pattern_set_request : change_token:string -> regex_pattern_set_id:string -> unit -> delete_regex_pattern_set_request

Create a delete_regex_pattern_set_request type

val make_delete_regex_match_set_response : ?change_token:string -> unit -> delete_regex_match_set_response

Create a delete_regex_match_set_response type

val make_delete_regex_match_set_request : change_token:string -> regex_match_set_id:string -> unit -> delete_regex_match_set_request

Create a delete_regex_match_set_request type

val make_delete_rate_based_rule_response : ?change_token:string -> unit -> delete_rate_based_rule_response

Create a delete_rate_based_rule_response type

val make_delete_rate_based_rule_request : change_token:string -> rule_id:string -> unit -> delete_rate_based_rule_request

Create a delete_rate_based_rule_request type

val make_delete_permission_policy_response : unit -> delete_permission_policy_response

Create a delete_permission_policy_response type

val make_delete_permission_policy_request : resource_arn:string -> unit -> delete_permission_policy_request

Create a delete_permission_policy_request type

val make_delete_logging_configuration_response : unit -> delete_logging_configuration_response

Create a delete_logging_configuration_response type

val make_delete_logging_configuration_request : resource_arn:string -> unit -> delete_logging_configuration_request

Create a delete_logging_configuration_request type

val make_delete_ip_set_response : ?change_token:string -> unit -> delete_ip_set_response

Create a delete_ip_set_response type

val make_delete_ip_set_request : change_token:string -> ip_set_id:string -> unit -> delete_ip_set_request

Create a delete_ip_set_request type

val make_delete_geo_match_set_response : ?change_token:string -> unit -> delete_geo_match_set_response

Create a delete_geo_match_set_response type

val make_delete_geo_match_set_request : change_token:string -> geo_match_set_id:string -> unit -> delete_geo_match_set_request

Create a delete_geo_match_set_request type

val make_delete_byte_match_set_response : ?change_token:string -> unit -> delete_byte_match_set_response

Create a delete_byte_match_set_response type

val make_delete_byte_match_set_request : change_token:string -> byte_match_set_id:string -> unit -> delete_byte_match_set_request

Create a delete_byte_match_set_request type

val make_create_xss_match_set_response : ?change_token:string -> ?xss_match_set:xss_match_set -> unit -> create_xss_match_set_response

Create a create_xss_match_set_response type

val make_create_xss_match_set_request : change_token:string -> name:string -> unit -> create_xss_match_set_request

Create a create_xss_match_set_request type

val make_create_web_acl_response : ?change_token:string -> ?web_ac_l:web_ac_l -> unit -> create_web_acl_response

Create a create_web_acl_response type

val make_create_web_acl_request : ?tags:tag list -> change_token:string -> default_action:waf_action -> metric_name:string -> name:string -> unit -> create_web_acl_request

Create a create_web_acl_request type

val make_create_web_acl_migration_stack_response : s3_object_url:string -> unit -> create_web_acl_migration_stack_response

Create a create_web_acl_migration_stack_response type

val make_create_web_acl_migration_stack_request : ignore_unsupported_type:bool -> s3_bucket_name:string -> web_acl_id:string -> unit -> create_web_acl_migration_stack_request

Create a create_web_acl_migration_stack_request type

val make_create_sql_injection_match_set_response : ?change_token:string -> ?sql_injection_match_set:sql_injection_match_set -> unit -> create_sql_injection_match_set_response

Create a create_sql_injection_match_set_response type

val make_create_sql_injection_match_set_request : change_token:string -> name:string -> unit -> create_sql_injection_match_set_request

Create a create_sql_injection_match_set_request type

val make_create_size_constraint_set_response : ?change_token:string -> ?size_constraint_set:size_constraint_set -> unit -> create_size_constraint_set_response

Create a create_size_constraint_set_response type

val make_create_size_constraint_set_request : change_token:string -> name:string -> unit -> create_size_constraint_set_request

Create a create_size_constraint_set_request type

val make_create_rule_response : ?change_token:string -> ?rule:rule -> unit -> create_rule_response

Create a create_rule_response type

val make_create_rule_request : ?tags:tag list -> change_token:string -> metric_name:string -> name:string -> unit -> create_rule_request

Create a create_rule_request type

val make_create_rule_group_response : ?change_token:string -> ?rule_group:rule_group -> unit -> create_rule_group_response

Create a create_rule_group_response type

val make_create_rule_group_request : ?tags:tag list -> change_token:string -> metric_name:string -> name:string -> unit -> create_rule_group_request

Create a create_rule_group_request type

val make_create_regex_pattern_set_response : ?change_token:string -> ?regex_pattern_set:regex_pattern_set -> unit -> create_regex_pattern_set_response

Create a create_regex_pattern_set_response type

val make_create_regex_pattern_set_request : change_token:string -> name:string -> unit -> create_regex_pattern_set_request

Create a create_regex_pattern_set_request type

val make_create_regex_match_set_response : ?change_token:string -> ?regex_match_set:regex_match_set -> unit -> create_regex_match_set_response

Create a create_regex_match_set_response type

val make_create_regex_match_set_request : change_token:string -> name:string -> unit -> create_regex_match_set_request

Create a create_regex_match_set_request type

val make_create_rate_based_rule_response : ?change_token:string -> ?rule:rate_based_rule -> unit -> create_rate_based_rule_response

Create a create_rate_based_rule_response type

val make_create_rate_based_rule_request : ?tags:tag list -> change_token:string -> rate_limit:int -> rate_key:rate_key -> metric_name:string -> name:string -> unit -> create_rate_based_rule_request

Create a create_rate_based_rule_request type

val make_create_ip_set_response : ?change_token:string -> ?ip_set:ip_set -> unit -> create_ip_set_response

Create a create_ip_set_response type

val make_create_ip_set_request : change_token:string -> name:string -> unit -> create_ip_set_request

Create a create_ip_set_request type

val make_create_geo_match_set_response : ?change_token:string -> ?geo_match_set:geo_match_set -> unit -> create_geo_match_set_response

Create a create_geo_match_set_response type

val make_create_geo_match_set_request : change_token:string -> name:string -> unit -> create_geo_match_set_request

Create a create_geo_match_set_request type

val make_create_byte_match_set_response : ?change_token:string -> ?byte_match_set:byte_match_set -> unit -> create_byte_match_set_response

Create a create_byte_match_set_response type

val make_create_byte_match_set_request : change_token:string -> name:string -> unit -> create_byte_match_set_request

Create a create_byte_match_set_request type

Operations

module CreateByteMatchSet : sig ... end
module CreateGeoMatchSet : sig ... end
module CreateIPSet : sig ... end
module CreateRateBasedRule : sig ... end
module CreateRegexMatchSet : sig ... end
module CreateRegexPatternSet : sig ... end
module CreateRule : sig ... end
module CreateRuleGroup : sig ... end
module CreateSizeConstraintSet : sig ... end
module CreateSqlInjectionMatchSet : sig ... end
module CreateWebACL : sig ... end
module CreateWebACLMigrationStack : sig ... end
module CreateXssMatchSet : sig ... end
module DeleteByteMatchSet : sig ... end
module DeleteGeoMatchSet : sig ... end
module DeleteIPSet : sig ... end
module DeleteLoggingConfiguration : sig ... end
module DeletePermissionPolicy : sig ... end
module DeleteRateBasedRule : sig ... end
module DeleteRegexMatchSet : sig ... end
module DeleteRegexPatternSet : sig ... end
module DeleteRule : sig ... end
module DeleteRuleGroup : sig ... end
module DeleteSizeConstraintSet : sig ... end
module DeleteSqlInjectionMatchSet : sig ... end
module DeleteWebACL : sig ... end
module DeleteXssMatchSet : sig ... end
module GetByteMatchSet : sig ... end
module GetChangeToken : sig ... end
module GetChangeTokenStatus : sig ... end
module GetGeoMatchSet : sig ... end
module GetIPSet : sig ... end
module GetLoggingConfiguration : sig ... end
module GetPermissionPolicy : sig ... end
module GetRateBasedRule : sig ... end
module GetRateBasedRuleManagedKeys : sig ... end
module GetRegexMatchSet : sig ... end
module GetRegexPatternSet : sig ... end
module GetRule : sig ... end
module GetRuleGroup : sig ... end
module GetSampledRequests : sig ... end
module GetSizeConstraintSet : sig ... end
module GetSqlInjectionMatchSet : sig ... end
module GetWebACL : sig ... end
module GetXssMatchSet : sig ... end
module ListActivatedRulesInRuleGroup : sig ... end
module ListByteMatchSets : sig ... end
module ListGeoMatchSets : sig ... end
module ListIPSets : sig ... end
module ListLoggingConfigurations : sig ... end
module ListRateBasedRules : sig ... end
module ListRegexMatchSets : sig ... end
module ListRegexPatternSets : sig ... end
module ListRuleGroups : sig ... end
module ListRules : sig ... end
module ListSizeConstraintSets : sig ... end
module ListSqlInjectionMatchSets : sig ... end
module ListSubscribedRuleGroups : sig ... end
module ListTagsForResource : sig ... end
module ListWebACLs : sig ... end
module ListXssMatchSets : sig ... end
module PutLoggingConfiguration : sig ... end
module PutPermissionPolicy : sig ... end
module TagResource : sig ... end
module UntagResource : sig ... end
module UpdateByteMatchSet : sig ... end
module UpdateGeoMatchSet : sig ... end
module UpdateIPSet : sig ... end
module UpdateRateBasedRule : sig ... end
module UpdateRegexMatchSet : sig ... end
module UpdateRegexPatternSet : sig ... end
module UpdateRule : sig ... end
module UpdateRuleGroup : sig ... end
module UpdateSizeConstraintSet : sig ... end
module UpdateSqlInjectionMatchSet : sig ... end
module UpdateWebACL : sig ... end
module UpdateXssMatchSet : sig ... end