Network.AWS.WAF.UpdateByteMatchSet

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

• Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.
• The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the 'User-Agent' header.
• The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.
• Where to look, such as at the beginning or the end of a query string.
• Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a ByteMatchSetUpdate object that matches web requests in which 'User-Agent' headers contain the string BadBot. You can then configure AWS WAF to block those requests.

To create and configure a ByteMatchSet, perform the following steps:

1. Create a 'ByteMatchSet.' For more information, see CreateByteMatchSet.
2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.
3. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Creating a Request

updateByteMatchSet

Arguments

:: Text

ubmsByteMatchSetId

-> Text

ubmsChangeToken

-> UpdateByteMatchSet

Creates a value of UpdateByteMatchSet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ubmsByteMatchSetId
• ubmsChangeToken
• ubmsUpdates

data UpdateByteMatchSet

See: updateByteMatchSet smart constructor.

Instances

Eq UpdateByteMatchSet

Data UpdateByteMatchSet

Read UpdateByteMatchSet

Show UpdateByteMatchSet

Generic UpdateByteMatchSet

ToJSON UpdateByteMatchSet

Hashable UpdateByteMatchSet

AWSRequest UpdateByteMatchSet

ToPath UpdateByteMatchSet

ToHeaders UpdateByteMatchSet

ToQuery UpdateByteMatchSet

type Rep UpdateByteMatchSet

type Rs UpdateByteMatchSet = UpdateByteMatchSetResponse

Request Lenses

ubmsByteMatchSetId :: Lens' UpdateByteMatchSet Text

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

ubmsChangeToken :: Lens' UpdateByteMatchSet Text

The value returned by the most recent call to GetChangeToken.

ubmsUpdates :: Lens' UpdateByteMatchSet [ByteMatchSetUpdate]

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

Destructuring the Response

updateByteMatchSetResponse

Arguments

:: Int

ubmsrsResponseStatus

-> UpdateByteMatchSetResponse

Creates a value of UpdateByteMatchSetResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ubmsrsChangeToken
• ubmsrsResponseStatus

data UpdateByteMatchSetResponse

See: updateByteMatchSetResponse smart constructor.

Instances

Eq UpdateByteMatchSetResponse

Data UpdateByteMatchSetResponse

Read UpdateByteMatchSetResponse

Show UpdateByteMatchSetResponse

Generic UpdateByteMatchSetResponse

type Rep UpdateByteMatchSetResponse

Response Lenses

ubmsrsChangeToken :: Lens' UpdateByteMatchSetResponse (Maybe Text)

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.

ubmsrsResponseStatus :: Lens' UpdateByteMatchSetResponse Int

The response status code.