Amazonka.WAF.UpdateByteMatchSet

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.

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

data UpdateByteMatchSet

See: newUpdateByteMatchSet smart constructor.

Constructors

UpdateByteMatchSet'

Fields

• byteMatchSetId :: Text

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

• changeToken :: Text

  The value returned by the most recent call to GetChangeToken.

• updates :: 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

Instances

ToJSON UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

toJSON :: UpdateByteMatchSet -> Value

toEncoding :: UpdateByteMatchSet -> Encoding

toJSONList :: [UpdateByteMatchSet] -> Value

toEncodingList :: [UpdateByteMatchSet] -> Encoding

ToHeaders UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

toHeaders :: UpdateByteMatchSet -> [Header]

ToPath UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

toPath :: UpdateByteMatchSet -> ByteString

ToQuery UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

toQuery :: UpdateByteMatchSet -> QueryString

AWSRequest UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

Associated Types

type AWSResponse UpdateByteMatchSet

Methods

request :: (Service -> Service) -> UpdateByteMatchSet -> Request UpdateByteMatchSet

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateByteMatchSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateByteMatchSet)))

Generic UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

Associated Types

type Rep UpdateByteMatchSet :: Type -> Type

Methods

from :: UpdateByteMatchSet -> Rep UpdateByteMatchSet x

to :: Rep UpdateByteMatchSet x -> UpdateByteMatchSet

Read UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

readsPrec :: Int -> ReadS UpdateByteMatchSet

readList :: ReadS [UpdateByteMatchSet]

readPrec :: ReadPrec UpdateByteMatchSet

readListPrec :: ReadPrec [UpdateByteMatchSet]

Show UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

showsPrec :: Int -> UpdateByteMatchSet -> ShowS

show :: UpdateByteMatchSet -> String

showList :: [UpdateByteMatchSet] -> ShowS

NFData UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

rnf :: UpdateByteMatchSet -> ()

Eq UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

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

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

Hashable UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

hashWithSalt :: Int -> UpdateByteMatchSet -> Int

hash :: UpdateByteMatchSet -> Int

type AWSResponse UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

type AWSResponse UpdateByteMatchSet = UpdateByteMatchSetResponse

type Rep UpdateByteMatchSet

Defined in Amazonka.WAF.UpdateByteMatchSet

type Rep UpdateByteMatchSet = D1 ('MetaData "UpdateByteMatchSet" "Amazonka.WAF.UpdateByteMatchSet" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" 'False) (C1 ('MetaCons "UpdateByteMatchSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "byteMatchSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty ByteMatchSetUpdate)))))

newUpdateByteMatchSet

Arguments

:: Text

UpdateByteMatchSet

-> Text

UpdateByteMatchSet

-> NonEmpty ByteMatchSetUpdate

$sel:updates:UpdateByteMatchSet'

-> UpdateByteMatchSet

Create a value of UpdateByteMatchSet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

UpdateByteMatchSet, updateByteMatchSet_changeToken - The value returned by the most recent call to GetChangeToken.

$sel:updates:UpdateByteMatchSet', updateByteMatchSet_updates - 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

Request Lenses

updateByteMatchSet_byteMatchSetId :: Lens' UpdateByteMatchSet Text

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

updateByteMatchSet_changeToken :: Lens' UpdateByteMatchSet Text

The value returned by the most recent call to GetChangeToken.

updateByteMatchSet_updates :: 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

data UpdateByteMatchSetResponse

See: newUpdateByteMatchSetResponse smart constructor.

Constructors

UpdateByteMatchSetResponse'

Fields

• changeToken :: 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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateByteMatchSetResponse

Defined in Amazonka.WAF.UpdateByteMatchSet

Associated Types

type Rep UpdateByteMatchSetResponse :: Type -> Type

Methods

from :: UpdateByteMatchSetResponse -> Rep UpdateByteMatchSetResponse x

to :: Rep UpdateByteMatchSetResponse x -> UpdateByteMatchSetResponse

Read UpdateByteMatchSetResponse

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

readsPrec :: Int -> ReadS UpdateByteMatchSetResponse

readList :: ReadS [UpdateByteMatchSetResponse]

readPrec :: ReadPrec UpdateByteMatchSetResponse

readListPrec :: ReadPrec [UpdateByteMatchSetResponse]

Show UpdateByteMatchSetResponse

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

showsPrec :: Int -> UpdateByteMatchSetResponse -> ShowS

show :: UpdateByteMatchSetResponse -> String

showList :: [UpdateByteMatchSetResponse] -> ShowS

NFData UpdateByteMatchSetResponse

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

rnf :: UpdateByteMatchSetResponse -> ()

Eq UpdateByteMatchSetResponse

Defined in Amazonka.WAF.UpdateByteMatchSet

Methods

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

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

type Rep UpdateByteMatchSetResponse

Defined in Amazonka.WAF.UpdateByteMatchSet

type Rep UpdateByteMatchSetResponse = D1 ('MetaData "UpdateByteMatchSetResponse" "Amazonka.WAF.UpdateByteMatchSet" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" 'False) (C1 ('MetaCons "UpdateByteMatchSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateByteMatchSetResponse

Arguments

:: Int

$sel:httpStatus:UpdateByteMatchSetResponse'

-> UpdateByteMatchSetResponse

Create a value of UpdateByteMatchSetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateByteMatchSet, updateByteMatchSetResponse_changeToken - 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.

$sel:httpStatus:UpdateByteMatchSetResponse', updateByteMatchSetResponse_httpStatus - The response's http status code.

Response Lenses

updateByteMatchSetResponse_changeToken :: 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.

updateByteMatchSetResponse_httpStatus :: Lens' UpdateByteMatchSetResponse Int

The response's http status code.