ByteMatchSet
Note
AWS WAF Classic support will end on September 30, 2025.
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.
Contents
- ByteMatchSetId
-
The
ByteMatchSetIdfor aByteMatchSet. You useByteMatchSetIdto get information about aByteMatchSet(see GetByteMatchSet), update aByteMatchSet(see UpdateByteMatchSet), insert aByteMatchSetinto aRuleor delete one from aRule(see UpdateRule), and delete aByteMatchSetfrom AWS WAF (see DeleteByteMatchSet).ByteMatchSetIdis returned by CreateByteMatchSet and by ListByteMatchSets.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: Yes
- ByteMatchTuples
-
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.
Type: Array of ByteMatchTuple objects
Required: Yes
- Name
-
A friendly name or description of the ByteMatchSet. You can't change
Nameafter you create aByteMatchSet.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
