libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WAFRegional.DeleteByteMatchSet

Description

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.

Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters).

If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.

To permanently delete a ByteMatchSet, perform the following steps:

  1. Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.
  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request.
  3. Submit a DeleteByteMatchSet request.
Synopsis

Creating a Request

data DeleteByteMatchSet Source #

See: newDeleteByteMatchSet smart constructor.

Constructors

DeleteByteMatchSet' 

Fields

  • byteMatchSetId :: Text

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

  • changeToken :: Text

    The value returned by the most recent call to GetChangeToken.

Instances

Instances details
Eq DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

(==) :: DeleteByteMatchSet -> DeleteByteMatchSet -> Bool #

(/=) :: DeleteByteMatchSet -> DeleteByteMatchSet -> Bool #

Read DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

readsPrec :: Int -> ReadS DeleteByteMatchSet #

readList :: ReadS [DeleteByteMatchSet] #

readPrec :: ReadPrec DeleteByteMatchSet #

readListPrec :: ReadPrec [DeleteByteMatchSet] #

Show DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

showsPrec :: Int -> DeleteByteMatchSet -> ShowS #

show :: DeleteByteMatchSet -> String #

showList :: [DeleteByteMatchSet] -> ShowS #

Generic DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Associated Types

type Rep DeleteByteMatchSet :: Type -> Type #

Methods

from :: DeleteByteMatchSet -> Rep DeleteByteMatchSet x #

to :: Rep DeleteByteMatchSet x -> DeleteByteMatchSet #

NFData DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

rnf :: DeleteByteMatchSet -> () #

Hashable DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

hashWithSalt :: Int -> DeleteByteMatchSet -> Int #

hash :: DeleteByteMatchSet -> Int #

ToJSON DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

toJSON :: DeleteByteMatchSet -> Value #

toEncoding :: DeleteByteMatchSet -> Encoding #

toJSONList :: [DeleteByteMatchSet] -> Value #

toEncodingList :: [DeleteByteMatchSet] -> Encoding #

AWSRequest DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Associated Types

type AWSResponse DeleteByteMatchSet #

Methods

request :: DeleteByteMatchSet -> Request DeleteByteMatchSet #

response :: MonadResource m => Logger -> Service -> Proxy DeleteByteMatchSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteByteMatchSet))) #

ToHeaders DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

toHeaders :: DeleteByteMatchSet -> [Header] #

ToPath DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

toPath :: DeleteByteMatchSet -> ByteString #

ToQuery DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

toQuery :: DeleteByteMatchSet -> QueryString #

type Rep DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

type Rep DeleteByteMatchSet = D1 ('MetaData "DeleteByteMatchSet" "Amazonka.WAFRegional.DeleteByteMatchSet" "libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional" 'False) (C1 ('MetaCons "DeleteByteMatchSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "byteMatchSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteByteMatchSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

type AWSResponse DeleteByteMatchSet = DeleteByteMatchSetResponse

newDeleteByteMatchSet Source #

Arguments

:: Text

$sel:byteMatchSetId:DeleteByteMatchSet'

-> Text

$sel:changeToken:DeleteByteMatchSet'

-> DeleteByteMatchSet 

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

$sel:byteMatchSetId:DeleteByteMatchSet', deleteByteMatchSet_byteMatchSetId - The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

$sel:changeToken:DeleteByteMatchSet', deleteByteMatchSet_changeToken - The value returned by the most recent call to GetChangeToken.

Request Lenses

deleteByteMatchSet_byteMatchSetId :: Lens' DeleteByteMatchSet Text Source #

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

deleteByteMatchSet_changeToken :: Lens' DeleteByteMatchSet Text Source #

The value returned by the most recent call to GetChangeToken.

Destructuring the Response

data DeleteByteMatchSetResponse Source #

See: newDeleteByteMatchSetResponse smart constructor.

Constructors

DeleteByteMatchSetResponse' 

Fields

  • changeToken :: Maybe Text

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

Instances details
Eq DeleteByteMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

(==) :: DeleteByteMatchSetResponse -> DeleteByteMatchSetResponse -> Bool #

(/=) :: DeleteByteMatchSetResponse -> DeleteByteMatchSetResponse -> Bool #

Read DeleteByteMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

readsPrec :: Int -> ReadS DeleteByteMatchSetResponse #

readList :: ReadS [DeleteByteMatchSetResponse] #

readPrec :: ReadPrec DeleteByteMatchSetResponse #

readListPrec :: ReadPrec [DeleteByteMatchSetResponse] #

Show DeleteByteMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

showsPrec :: Int -> DeleteByteMatchSetResponse -> ShowS #

show :: DeleteByteMatchSetResponse -> String #

showList :: [DeleteByteMatchSetResponse] -> ShowS #

Generic DeleteByteMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Associated Types

type Rep DeleteByteMatchSetResponse :: Type -> Type #

Methods

from :: DeleteByteMatchSetResponse -> Rep DeleteByteMatchSetResponse x #

to :: Rep DeleteByteMatchSetResponse x -> DeleteByteMatchSetResponse #

NFData DeleteByteMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

Methods

rnf :: DeleteByteMatchSetResponse -> () #

type Rep DeleteByteMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteByteMatchSet

type Rep DeleteByteMatchSetResponse = D1 ('MetaData "DeleteByteMatchSetResponse" "Amazonka.WAFRegional.DeleteByteMatchSet" "libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional" 'False) (C1 ('MetaCons "DeleteByteMatchSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteByteMatchSetResponse Source #

Arguments

:: Int

$sel:httpStatus:DeleteByteMatchSetResponse'

-> DeleteByteMatchSetResponse 

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

$sel:changeToken:DeleteByteMatchSet', deleteByteMatchSetResponse_changeToken - The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

$sel:httpStatus:DeleteByteMatchSetResponse', deleteByteMatchSetResponse_httpStatus - The response's http status code.

Response Lenses

deleteByteMatchSetResponse_changeToken :: Lens' DeleteByteMatchSetResponse (Maybe Text) Source #

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

deleteByteMatchSetResponse_httpStatus :: Lens' DeleteByteMatchSetResponse Int Source #

The response's http status code.