waf_get_byte_match_set: This is AWS WAF Classic documentation

Description

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.

Usage

waf_get_byte_match_set(ByteMatchSetId)

Arguments

ByteMatchSetId

[required] The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by create_byte_match_set and by list_byte_match_sets.

Value

A list with the following syntax:

list(
  ByteMatchSet = list(
    ByteMatchSetId = "string",
    Name = "string",
    ByteMatchTuples = list(
      list(
        FieldToMatch = list(
          Type = "URI"|"QUERY_STRING"|"HEADER"|"METHOD"|"BODY"|"SINGLE_QUERY_ARG"|"ALL_QUERY_ARGS",
          Data = "string"
        ),
        TargetString = raw,
        TextTransformation = "NONE"|"COMPRESS_WHITE_SPACE"|"HTML_ENTITY_DECODE"|"LOWERCASE"|"CMD_LINE"|"URL_DECODE",
        PositionalConstraint = "EXACTLY"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CONTAINS_WORD"
      )
    )
  )
)

Request syntax

svc$get_byte_match_set(
  ByteMatchSetId = "string"
)

Examples

Run this code

# NOT RUN {
# The following example returns the details of a byte match set with the
# ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.
svc$get_byte_match_set(
  ByteMatchSetId = "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5"
)
# }
# NOT RUN {
# }