Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.WAF.UpdateByteMatchSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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:

Create a ByteMatchSet. For more information, see CreateByteMatchSet .
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.
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`
-> NonEmpty ByteMatchSetUpdate	`ubmsUpdates`
-> 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 - The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets .
ubmsChangeToken - The value returned by the most recent call to GetChangeToken .
ubmsUpdates - 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

data UpdateByteMatchSet #

See: updateByteMatchSet smart constructor.

Instances

Eq UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods (==) :: UpdateByteMatchSet -> UpdateByteMatchSet -> Bool # (/=) :: UpdateByteMatchSet -> UpdateByteMatchSet -> Bool #
Data UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.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 #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods readsPrec :: Int -> ReadS UpdateByteMatchSet # readList :: ReadS [UpdateByteMatchSet] # readPrec :: ReadPrec UpdateByteMatchSet # readListPrec :: ReadPrec [UpdateByteMatchSet] #
Show UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods showsPrec :: Int -> UpdateByteMatchSet -> ShowS # show :: UpdateByteMatchSet -> String # showList :: [UpdateByteMatchSet] -> ShowS #
Generic UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Associated Types type Rep UpdateByteMatchSet :: * -> * # Methods from :: UpdateByteMatchSet -> Rep UpdateByteMatchSet x # to :: Rep UpdateByteMatchSet x -> UpdateByteMatchSet #
Hashable UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods hashWithSalt :: Int -> UpdateByteMatchSet -> Int # hash :: UpdateByteMatchSet -> Int #
ToJSON UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods toJSON :: UpdateByteMatchSet -> Value # toEncoding :: UpdateByteMatchSet -> Encoding # toJSONList :: [UpdateByteMatchSet] -> Value # toEncodingList :: [UpdateByteMatchSet] -> Encoding #
AWSRequest UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Associated Types type Rs UpdateByteMatchSet :: * # Methods request :: UpdateByteMatchSet -> Request UpdateByteMatchSet # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateByteMatchSet -> ClientResponse -> m (Response UpdateByteMatchSet) #
ToHeaders UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods toHeaders :: UpdateByteMatchSet -> [Header] #
ToPath UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods toPath :: UpdateByteMatchSet -> ByteString #
ToQuery UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods toQuery :: UpdateByteMatchSet -> QueryString #
NFData UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods rnf :: UpdateByteMatchSet -> () #
type Rep UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet type Rep UpdateByteMatchSet = D1 (MetaData "UpdateByteMatchSet" "Network.AWS.WAF.UpdateByteMatchSet" "amazonka-waf-1.6.0-CW9xC92N0D3LNApAd7iUoL" False) (C1 (MetaCons "UpdateByteMatchSet'" PrefixI True) (S1 (MetaSel (Just "_ubmsByteMatchSetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_ubmsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_ubmsUpdates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 ByteMatchSetUpdate)))))
type Rs UpdateByteMatchSet #
Instance details Defined in Network.AWS.WAF.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 (NonEmpty 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 - 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 - -- | The response status code.

data UpdateByteMatchSetResponse #

See: updateByteMatchSetResponse smart constructor.

Instances

Eq UpdateByteMatchSetResponse #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods (==) :: UpdateByteMatchSetResponse -> UpdateByteMatchSetResponse -> Bool # (/=) :: UpdateByteMatchSetResponse -> UpdateByteMatchSetResponse -> Bool #
Data UpdateByteMatchSetResponse #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet 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 #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods readsPrec :: Int -> ReadS UpdateByteMatchSetResponse # readList :: ReadS [UpdateByteMatchSetResponse] # readPrec :: ReadPrec UpdateByteMatchSetResponse # readListPrec :: ReadPrec [UpdateByteMatchSetResponse] #
Show UpdateByteMatchSetResponse #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods showsPrec :: Int -> UpdateByteMatchSetResponse -> ShowS # show :: UpdateByteMatchSetResponse -> String # showList :: [UpdateByteMatchSetResponse] -> ShowS #
Generic UpdateByteMatchSetResponse #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Associated Types type Rep UpdateByteMatchSetResponse :: * -> * # Methods from :: UpdateByteMatchSetResponse -> Rep UpdateByteMatchSetResponse x # to :: Rep UpdateByteMatchSetResponse x -> UpdateByteMatchSetResponse #
NFData UpdateByteMatchSetResponse #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet Methods rnf :: UpdateByteMatchSetResponse -> () #
type Rep UpdateByteMatchSetResponse #
Instance details Defined in Network.AWS.WAF.UpdateByteMatchSet type Rep UpdateByteMatchSetResponse = D1 (MetaData "UpdateByteMatchSetResponse" "Network.AWS.WAF.UpdateByteMatchSet" "amazonka-waf-1.6.0-CW9xC92N0D3LNApAd7iUoL" False) (C1 (MetaCons "UpdateByteMatchSetResponse'" PrefixI True) (S1 (MetaSel (Just "_ubmsrsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_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.