IAmazonWAFRegional.DeleteByteMatchSetAsync Method (string, string, CancellationToken)

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:

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

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeleteByteMatchSet and EndDeleteByteMatchSet.

Namespace: Amazon.WAFRegional
Assembly: AWSSDK.WAFRegional.dll
Version: 3.x.y.z

Syntax

public abstract Task<DeleteByteMatchSetResponse> DeleteByteMatchSetAsync(
         String byteMatchSetId,
         String changeToken,
         CancellationToken cancellationToken
)

Parameters

byteMatchSetId: Type: System.String

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

changeToken: Type: System.String

The value returned by the most recent call to GetChangeToken.

cancellationToken: Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value

Type: Task<DeleteByteMatchSetResponse>

The response from the DeleteByteMatchSet service method, as returned by WAFRegional.

Exceptions

Exception	Condition
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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

IAmazonWAFRegional.DeleteByteMatchSetAsync (string, string, CancellationToken)

Method

Syntax

Parameters

Return Value

Exceptions

Version Information

See Also