Amazonka.WAF.UpdateRegexPatternSet

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 RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values:

• Whether to insert or delete the RegexPatternString.
• The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.

For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to:

• BadBot
• BadB0t
• B@dBot
• B@dB0t

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

1. Create a RegexPatternSet. For more information, see CreateRegexPatternSet.
2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.
3. Submit an UpdateRegexPatternSet request to specify the regular expression pattern 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 UpdateRegexPatternSet

See: newUpdateRegexPatternSet smart constructor.

Constructors

UpdateRegexPatternSet'

Fields

• regexPatternSetId :: Text

  The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

• updates :: NonEmpty RegexPatternSetUpdate

  An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.

• changeToken :: Text

  The value returned by the most recent call to GetChangeToken.

Instances

ToJSON UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

toJSON :: UpdateRegexPatternSet -> Value

toEncoding :: UpdateRegexPatternSet -> Encoding

toJSONList :: [UpdateRegexPatternSet] -> Value

toEncodingList :: [UpdateRegexPatternSet] -> Encoding

ToHeaders UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

toHeaders :: UpdateRegexPatternSet -> [Header]

ToPath UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

toPath :: UpdateRegexPatternSet -> ByteString

ToQuery UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

toQuery :: UpdateRegexPatternSet -> QueryString

AWSRequest UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

Associated Types

type AWSResponse UpdateRegexPatternSet

Methods

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

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

Generic UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

Associated Types

type Rep UpdateRegexPatternSet :: Type -> Type

Methods

from :: UpdateRegexPatternSet -> Rep UpdateRegexPatternSet x

to :: Rep UpdateRegexPatternSet x -> UpdateRegexPatternSet

Read UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

readsPrec :: Int -> ReadS UpdateRegexPatternSet

readList :: ReadS [UpdateRegexPatternSet]

readPrec :: ReadPrec UpdateRegexPatternSet

readListPrec :: ReadPrec [UpdateRegexPatternSet]

Show UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

showsPrec :: Int -> UpdateRegexPatternSet -> ShowS

show :: UpdateRegexPatternSet -> String

showList :: [UpdateRegexPatternSet] -> ShowS

NFData UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

rnf :: UpdateRegexPatternSet -> ()

Eq UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

(==) :: UpdateRegexPatternSet -> UpdateRegexPatternSet -> Bool

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

Hashable UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

hashWithSalt :: Int -> UpdateRegexPatternSet -> Int

hash :: UpdateRegexPatternSet -> Int

type AWSResponse UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

type AWSResponse UpdateRegexPatternSet = UpdateRegexPatternSetResponse

type Rep UpdateRegexPatternSet

Defined in Amazonka.WAF.UpdateRegexPatternSet

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

newUpdateRegexPatternSet

Arguments

:: Text

UpdateRegexPatternSet

-> NonEmpty RegexPatternSetUpdate

$sel:updates:UpdateRegexPatternSet'

-> Text

UpdateRegexPatternSet

-> UpdateRegexPatternSet

Create a value of UpdateRegexPatternSet 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:

UpdateRegexPatternSet, updateRegexPatternSet_regexPatternSetId - The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

$sel:updates:UpdateRegexPatternSet', updateRegexPatternSet_updates - An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.

UpdateRegexPatternSet, updateRegexPatternSet_changeToken - The value returned by the most recent call to GetChangeToken.

Request Lenses

updateRegexPatternSet_regexPatternSetId :: Lens' UpdateRegexPatternSet Text

The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

updateRegexPatternSet_updates :: Lens' UpdateRegexPatternSet (NonEmpty RegexPatternSetUpdate)

An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.

updateRegexPatternSet_changeToken :: Lens' UpdateRegexPatternSet Text

The value returned by the most recent call to GetChangeToken.

Destructuring the Response

data UpdateRegexPatternSetResponse

See: newUpdateRegexPatternSetResponse smart constructor.

Constructors

UpdateRegexPatternSetResponse'

Fields

• changeToken :: Maybe Text

  The ChangeToken that you used to submit the UpdateRegexPatternSet 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 UpdateRegexPatternSetResponse

Defined in Amazonka.WAF.UpdateRegexPatternSet

Associated Types

type Rep UpdateRegexPatternSetResponse :: Type -> Type

Methods

from :: UpdateRegexPatternSetResponse -> Rep UpdateRegexPatternSetResponse x

to :: Rep UpdateRegexPatternSetResponse x -> UpdateRegexPatternSetResponse

Read UpdateRegexPatternSetResponse

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

readsPrec :: Int -> ReadS UpdateRegexPatternSetResponse

readList :: ReadS [UpdateRegexPatternSetResponse]

readPrec :: ReadPrec UpdateRegexPatternSetResponse

readListPrec :: ReadPrec [UpdateRegexPatternSetResponse]

Show UpdateRegexPatternSetResponse

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

showsPrec :: Int -> UpdateRegexPatternSetResponse -> ShowS

show :: UpdateRegexPatternSetResponse -> String

showList :: [UpdateRegexPatternSetResponse] -> ShowS

NFData UpdateRegexPatternSetResponse

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

rnf :: UpdateRegexPatternSetResponse -> ()

Eq UpdateRegexPatternSetResponse

Defined in Amazonka.WAF.UpdateRegexPatternSet

Methods

(==) :: UpdateRegexPatternSetResponse -> UpdateRegexPatternSetResponse -> Bool

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

type Rep UpdateRegexPatternSetResponse

Defined in Amazonka.WAF.UpdateRegexPatternSet

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

newUpdateRegexPatternSetResponse

Arguments

:: Int

$sel:httpStatus:UpdateRegexPatternSetResponse'

-> UpdateRegexPatternSetResponse

Create a value of UpdateRegexPatternSetResponse 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:

UpdateRegexPatternSet, updateRegexPatternSetResponse_changeToken - The ChangeToken that you used to submit the UpdateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

$sel:httpStatus:UpdateRegexPatternSetResponse', updateRegexPatternSetResponse_httpStatus - The response's http status code.

Response Lenses

updateRegexPatternSetResponse_changeToken :: Lens' UpdateRegexPatternSetResponse (Maybe Text)

The ChangeToken that you used to submit the UpdateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

updateRegexPatternSetResponse_httpStatus :: Lens' UpdateRegexPatternSetResponse Int

The response's http status code.