amazonka-waf-regional-2.0: Amazon WAF Regional SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WAFRegional.DeleteIPSet

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 an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses.

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

To permanently delete an IPSet from AWS WAF, perform the following steps:

  1. Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.
  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request.
  3. Submit a DeleteIPSet request.
Synopsis

Creating a Request

data DeleteIPSet Source #

See: newDeleteIPSet smart constructor.

Constructors

DeleteIPSet' 

Fields

  • iPSetId :: Text

    The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.

  • changeToken :: Text

    The value returned by the most recent call to GetChangeToken.

Instances

Instances details
ToJSON DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

ToHeaders DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

Methods

toHeaders :: DeleteIPSet -> [Header] #

ToPath DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

ToQuery DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

AWSRequest DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

Associated Types

type AWSResponse DeleteIPSet #

Generic DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

Associated Types

type Rep DeleteIPSet :: Type -> Type #

Read DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

Show DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

NFData DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

Methods

rnf :: DeleteIPSet -> () #

Eq DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

Hashable DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

type AWSResponse DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

type Rep DeleteIPSet Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

type Rep DeleteIPSet = D1 ('MetaData "DeleteIPSet" "Amazonka.WAFRegional.DeleteIPSet" "amazonka-waf-regional-2.0-83dY3vKOuQzAAW7M6EmzRI" 'False) (C1 ('MetaCons "DeleteIPSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "iPSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteIPSet Source #

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

DeleteIPSet, deleteIPSet_iPSetId - The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.

DeleteIPSet, deleteIPSet_changeToken - The value returned by the most recent call to GetChangeToken.

Request Lenses

deleteIPSet_iPSetId :: Lens' DeleteIPSet Text Source #

The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.

deleteIPSet_changeToken :: Lens' DeleteIPSet Text Source #

The value returned by the most recent call to GetChangeToken.

Destructuring the Response

data DeleteIPSetResponse Source #

See: newDeleteIPSetResponse smart constructor.

Constructors

DeleteIPSetResponse' 

Fields

  • changeToken :: Maybe Text

    The ChangeToken that you used to submit the DeleteIPSet 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
Generic DeleteIPSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

Associated Types

type Rep DeleteIPSetResponse :: Type -> Type #

Read DeleteIPSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

Show DeleteIPSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

NFData DeleteIPSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

Methods

rnf :: DeleteIPSetResponse -> () #

Eq DeleteIPSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

type Rep DeleteIPSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteIPSet

type Rep DeleteIPSetResponse = D1 ('MetaData "DeleteIPSetResponse" "Amazonka.WAFRegional.DeleteIPSet" "amazonka-waf-regional-2.0-83dY3vKOuQzAAW7M6EmzRI" 'False) (C1 ('MetaCons "DeleteIPSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteIPSetResponse Source #

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

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

$sel:httpStatus:DeleteIPSetResponse', deleteIPSetResponse_httpStatus - The response's http status code.

Response Lenses

deleteIPSetResponse_changeToken :: Lens' DeleteIPSetResponse (Maybe Text) Source #

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