GetByteMatchSet
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.
Returns the ByteMatchSet specified by ByteMatchSetId.
Request Syntax
{
"ByteMatchSetId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ByteMatchSetId
-
The
ByteMatchSetIdof the ByteMatchSet that you want to get.ByteMatchSetIdis returned by CreateByteMatchSet and by ListByteMatchSets.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: Yes
Response Syntax
{
"ByteMatchSet": {
"ByteMatchSetId": "string",
"ByteMatchTuples": [
{
"FieldToMatch": {
"Data": "string",
"Type": "string"
},
"PositionalConstraint": "string",
"TargetString": blob,
"TextTransformation": "string"
}
],
"Name": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ByteMatchSet
-
Information about the ByteMatchSet that you specified in the
GetByteMatchSetrequest. For more information, see the following topics:-
ByteMatchSet: Contains
ByteMatchSetId,ByteMatchTuples, andName -
ByteMatchTuples: Contains an array of ByteMatchTuple objects. EachByteMatchTupleobject contains FieldToMatch,PositionalConstraint,TargetString, andTextTransformation -
FieldToMatch: Contains
DataandType
Type: ByteMatchSet object
-
Errors
For information about the errors that are common to all actions, see Common Errors.
- WAFInternalErrorException
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
- WAFInvalidAccountException
-
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
- WAFNonexistentItemException
-
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
