AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Deletes the specified API key.

After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DeleteAPIKeyAsync.

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

Syntax

C#
public virtual DeleteAPIKeyResponse DeleteAPIKey(
         DeleteAPIKeyRequest request
)

Parameters

request
Type: Amazon.WAFV2.Model.DeleteAPIKeyRequest

Container for the necessary parameters to execute the DeleteAPIKey service method.

Return Value


The response from the DeleteAPIKey service method, as returned by WAFV2.

Exceptions

ExceptionCondition
WAFInternalErrorException Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
WAFInvalidOperationException The operation isn't valid.
WAFInvalidParameterException The operation failed because WAF didn't recognize a parameter in the request. For example: You specified a parameter name or value that isn't valid. Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
WAFOptimisticLockException WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

Version Information

.NET Framework:
Supported in: 4.7.2 and newer

See Also