delete_geo_match_set

WAFRegional.Client.delete_geo_match_set(**kwargs)

Note

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 GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries.

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

To permanently delete a GeoMatchSet from AWS WAF, perform the following steps:

  • Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet.
  • Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request.
  • Submit a DeleteGeoMatchSet request.

See also: AWS API Documentation

Request Syntax

response = client.delete_geo_match_set(
    GeoMatchSetId='string',
    ChangeToken='string'
)
Parameters
  • GeoMatchSetId (string) --

    [REQUIRED]

    The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

  • ChangeToken (string) --

    [REQUIRED]

    The value returned by the most recent call to GetChangeToken.

Return type

dict

Returns

Response Syntax

{
    'ChangeToken': 'string'
}

Response Structure

  • (dict) --

    • ChangeToken (string) --

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

Exceptions

  • WAFRegional.Client.exceptions.WAFStaleDataException
  • WAFRegional.Client.exceptions.WAFInternalErrorException
  • WAFRegional.Client.exceptions.WAFInvalidAccountException
  • WAFRegional.Client.exceptions.WAFNonexistentItemException
  • WAFRegional.Client.exceptions.WAFReferencedItemException
  • WAFRegional.Client.exceptions.WAFNonEmptyEntityException