WAF / Client / delete_sql_injection_match_set

delete_sql_injection_match_set#

WAF.Client.delete_sql_injection_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 SqlInjectionMatchSet. You can’t delete a SqlInjectionMatchSet if it’s still used in any Rules or if it still contains any SqlInjectionMatchTuple objects.

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

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

  • Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.

  • Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request.

  • Submit a DeleteSqlInjectionMatchSet request.

See also: AWS API Documentation

Request Syntax

response = client.delete_sql_injection_match_set(
    SqlInjectionMatchSetId='string',
    ChangeToken='string'
)
Parameters:

  • SqlInjectionMatchSetId (string) –

    [REQUIRED]

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

  • ChangeToken (string) –

    [REQUIRED]

    The value returned by the most recent call to GetChangeToken.

Return type:

dict

Returns:

Response Syntax

{
    'ChangeToken': 'string'
}

Response Structure

  • (dict) –

    The response to a request to delete a SqlInjectionMatchSet from AWS WAF.

    • ChangeToken (string) –

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

Exceptions

  • WAF.Client.exceptions.WAFInternalErrorException

  • WAF.Client.exceptions.WAFInvalidAccountException

  • WAF.Client.exceptions.WAFNonexistentItemException

  • WAF.Client.exceptions.WAFReferencedItemException

  • WAF.Client.exceptions.WAFStaleDataException

  • WAF.Client.exceptions.WAFNonEmptyEntityException

Examples

The following example deletes a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

response = client.delete_sql_injection_match_set(
    ChangeToken='abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    SqlInjectionMatchSetId='example1ds3t-46da-4fdb-b8d5-abc321j569j5',
)

print(response)

Expected Output:

{
    'ChangeToken': 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'ResponseMetadata': {
        '...': '...',
    },
}