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

Methods

(==) :: UpdateByteMatchSet -> UpdateByteMatchSet -> Bool

(/=) :: UpdateByteMatchSet -> UpdateByteMatchSet -> Bool

Data UpdateByteMatchSet

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateByteMatchSet -> c UpdateByteMatchSet

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateByteMatchSet

toConstr :: UpdateByteMatchSet -> Constr

dataTypeOf :: UpdateByteMatchSet -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateByteMatchSet)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateByteMatchSet)

gmapT :: (forall b. Data b => b -> b) -> UpdateByteMatchSet -> UpdateByteMatchSet

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateByteMatchSet -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateByteMatchSet -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateByteMatchSet -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateByteMatchSet -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateByteMatchSet -> m UpdateByteMatchSet

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateByteMatchSet -> m UpdateByteMatchSet

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateByteMatchSet -> m UpdateByteMatchSet

Read UpdateByteMatchSet

Methods

readsPrec :: Int -> ReadS UpdateByteMatchSet

readList :: ReadS [UpdateByteMatchSet]

readPrec :: ReadPrec UpdateByteMatchSet

readListPrec :: ReadPrec [UpdateByteMatchSet]

Show UpdateByteMatchSet

Methods

showsPrec :: Int -> UpdateByteMatchSet -> ShowS

show :: UpdateByteMatchSet -> String

showList :: [UpdateByteMatchSet] -> ShowS

Generic UpdateByteMatchSet

Associated Types

type Rep UpdateByteMatchSet :: * -> *

Methods

from :: UpdateByteMatchSet -> Rep UpdateByteMatchSet x

to :: Rep UpdateByteMatchSet x -> UpdateByteMatchSet

ToJSON UpdateByteMatchSet

Methods

toJSON :: UpdateByteMatchSet -> Value

toEncoding :: UpdateByteMatchSet -> Encoding

Hashable UpdateByteMatchSet

Methods

hashWithSalt :: Int -> UpdateByteMatchSet -> Int

hash :: UpdateByteMatchSet -> Int

NFData UpdateByteMatchSet

Methods

rnf :: UpdateByteMatchSet -> ()

AWSRequest UpdateByteMatchSet

Associated Types

type Rs UpdateByteMatchSet :: *

Methods

request :: UpdateByteMatchSet -> Request UpdateByteMatchSet

response :: MonadResource m => Logger -> Service -> Proxy * UpdateByteMatchSet -> ClientResponse -> m (Response UpdateByteMatchSet)

ToPath UpdateByteMatchSet

Methods

toPath :: UpdateByteMatchSet -> ByteString

ToHeaders UpdateByteMatchSet

Methods

toHeaders :: UpdateByteMatchSet -> [Header]

ToQuery UpdateByteMatchSet

Methods

toQuery :: UpdateByteMatchSet -> QueryString

type Rep UpdateByteMatchSet

type Rep UpdateByteMatchSet = D1 (MetaData "UpdateByteMatchSet" "Network.AWS.WAF.UpdateByteMatchSet" "amazonka-waf-1.4.2-GUOLg0Y7f3KJKVyTZ0nfG8" False) (C1 (MetaCons "UpdateByteMatchSet'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ubmsByteMatchSetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_ubmsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ubmsUpdates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [ByteMatchSetUpdate])))))

type Rs 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

Methods

(==) :: UpdateByteMatchSetResponse -> UpdateByteMatchSetResponse -> Bool

(/=) :: UpdateByteMatchSetResponse -> UpdateByteMatchSetResponse -> Bool

Data UpdateByteMatchSetResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateByteMatchSetResponse -> c UpdateByteMatchSetResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateByteMatchSetResponse

toConstr :: UpdateByteMatchSetResponse -> Constr

dataTypeOf :: UpdateByteMatchSetResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateByteMatchSetResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateByteMatchSetResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateByteMatchSetResponse -> UpdateByteMatchSetResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateByteMatchSetResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateByteMatchSetResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateByteMatchSetResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateByteMatchSetResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateByteMatchSetResponse -> m UpdateByteMatchSetResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateByteMatchSetResponse -> m UpdateByteMatchSetResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateByteMatchSetResponse -> m UpdateByteMatchSetResponse

Read UpdateByteMatchSetResponse

Methods

readsPrec :: Int -> ReadS UpdateByteMatchSetResponse

readList :: ReadS [UpdateByteMatchSetResponse]

readPrec :: ReadPrec UpdateByteMatchSetResponse

readListPrec :: ReadPrec [UpdateByteMatchSetResponse]

Show UpdateByteMatchSetResponse

Methods

showsPrec :: Int -> UpdateByteMatchSetResponse -> ShowS

show :: UpdateByteMatchSetResponse -> String

showList :: [UpdateByteMatchSetResponse] -> ShowS

Generic UpdateByteMatchSetResponse

Associated Types

type Rep UpdateByteMatchSetResponse :: * -> *

Methods

from :: UpdateByteMatchSetResponse -> Rep UpdateByteMatchSetResponse x

to :: Rep UpdateByteMatchSetResponse x -> UpdateByteMatchSetResponse

NFData UpdateByteMatchSetResponse

Methods

rnf :: UpdateByteMatchSetResponse -> ()

type Rep UpdateByteMatchSetResponse

type Rep UpdateByteMatchSetResponse = D1 (MetaData "UpdateByteMatchSetResponse" "Network.AWS.WAF.UpdateByteMatchSet" "amazonka-waf-1.4.2-GUOLg0Y7f3KJKVyTZ0nfG8" False) (C1 (MetaCons "UpdateByteMatchSetResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ubmsrsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ubmsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

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.