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.
Creates an API key that contains a set of token domains.
API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.
You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.
For .NET Core this operation is only available in asynchronous form. Please refer to CreateAPIKeyAsync.
Namespace: Amazon.WAFV2
Assembly: AWSSDK.WAFV2.dll
Version: 3.x.y.z
public abstract CreateAPIKeyResponse CreateAPIKey( CreateAPIKeyRequest request )
Container for the necessary parameters to execute the CreateAPIKey service method.
| Exception | Condition |
|---|---|
| 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. |
| WAFLimitsExceededException | WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide. |
.NET Framework:
Supported in: 4.7.2 and newer