delete_geo_match_set `async` ¶

delete_geo_match_set(
    geo_match_set_id: ResourceId,
    change_token: ChangeToken,
    *,
    config_overrides: Optional[AsyncWAFRegionalClientConfig] = None,
) -> DeleteGeoMatchSetResponse

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.

Parameters:

geo_match_set_id (ResourceId) –

The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
change_token (ChangeToken) –

The value returned by the most recent call to GetChangeToken.

Raises:

WAFInternalErrorException –

The operation failed because of a system problem, even though the request was valid. Retry your request.
WAFInvalidAccountException –

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
WAFNonEmptyEntityException –
The operation failed because you tried to delete an object that isn't empty. For example:
- You tried to delete a WebACL that still contains one or more Rule objects.
- You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.
- You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.
- You tried to delete an IPSet that references one or more IP addresses.
WAFNonexistentItemException –

The operation failed because the referenced object doesn't exist.
WAFReferencedItemException –
The operation failed because you tried to delete an object that is still in use. For example:
- You tried to delete a ByteMatchSet that is still referenced by a Rule.
- You tried to delete a Rule that is still referenced by a WebACL.
WAFStaleDataException –

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_waf_regional/_services/async_waf_regional.py

async def delete_geo_match_set(
    self,
    geo_match_set_id: "capo_waf_regional.types.resource_id.ResourceId",
    change_token: "capo_waf_regional.types.change_token.ChangeToken",
    *,
    config_overrides: Optional[AsyncWAFRegionalClientConfig] = None,
) -> "capo_waf_regional.types.delete_geo_match_set_response.DeleteGeoMatchSetResponse":
    """<note> <p>This is <b>AWS WAF Classic</b> documentation. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS WAF Classic</a> in the developer guide.</p> <p> <b>For the latest version of AWS WAF</b>, use the AWS WAFV2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of endpoints for regional and global use. </p> </note> <p>Permanently deletes a <a>GeoMatchSet</a>. You can't delete a <code>GeoMatchSet</code> if it's still used in any <code>Rules</code> or if it still includes any countries.</p> <p>If you just want to remove a <code>GeoMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>.</p> <p>To permanently delete a <code>GeoMatchSet</code> from AWS WAF, perform the following steps:</p> <ol> <li> <p>Update the <code>GeoMatchSet</code> to remove any countries. For more information, see <a>UpdateGeoMatchSet</a>.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteGeoMatchSet</code> request.</p> </li> <li> <p>Submit a <code>DeleteGeoMatchSet</code> request.</p> </li> </ol>

    Args:
        geo_match_set_id: <p>The <code>GeoMatchSetID</code> of the <a>GeoMatchSet</a> that you want to delete. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>.</p>
        change_token: <p>The value returned by the most recent call to <a>GetChangeToken</a>.</p>

    Raises:
        capo_waf_regional.errors.waf_internal_error_exception.WAFInternalErrorException: <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
        capo_waf_regional.errors.waf_invalid_account_exception.WAFInvalidAccountException: <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
        capo_waf_regional.errors.waf_non_empty_entity_exception.WAFNonEmptyEntityException: <p>The operation failed because you tried to delete an object that isn't empty. For example:</p> <ul> <li> <p>You tried to delete a <code>WebACL</code> that still contains one or more <code>Rule</code> objects.</p> </li> <li> <p>You tried to delete a <code>Rule</code> that still contains one or more <code>ByteMatchSet</code> objects or other predicates.</p> </li> <li> <p>You tried to delete a <code>ByteMatchSet</code> that contains one or more <code>ByteMatchTuple</code> objects.</p> </li> <li> <p>You tried to delete an <code>IPSet</code> that references one or more IP addresses.</p> </li> </ul>
        capo_waf_regional.errors.waf_nonexistent_item_exception.WAFNonexistentItemException: <p>The operation failed because the referenced object doesn't exist.</p>
        capo_waf_regional.errors.waf_referenced_item_exception.WAFReferencedItemException: <p>The operation failed because you tried to delete an object that is still in use. For example:</p> <ul> <li> <p>You tried to delete a <code>ByteMatchSet</code> that is still referenced by a <code>Rule</code>.</p> </li> <li> <p>You tried to delete a <code>Rule</code> that is still referenced by a <code>WebACL</code>.</p> </li> </ul>
        capo_waf_regional.errors.waf_stale_data_exception.WAFStaleDataException: <p>The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.</p>
        capo_waf_regional.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_waf_regional.types.delete_geo_match_set_request.DeleteGeoMatchSetRequest]",
    ) -> AsyncOperationResponse[
        "capo_waf_regional.types.delete_geo_match_set_response.DeleteGeoMatchSetResponse"
    ]:
        import capo_waf_regional._operations.awswaf_regional_20161128.delete_geo_match_set

        (
            output,
            http_response,
        ) = await capo_waf_regional._operations.awswaf_regional_20161128.delete_geo_match_set.async_delete_geo_match_set(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteGeoMatchSet")
    )
    input_: capo_waf_regional.types.delete_geo_match_set_request.DeleteGeoMatchSetRequest = {
        "geo_match_set_id": geo_match_set_id,
        "change_token": change_token,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_geo_match_set async ¶

delete_geo_match_set `async` ¶