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 a unique key that you can distribute to clients who invoke your API.
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 BeginCreateApiKey and EndCreateApiKey.
Namespace: Amazon.AppSync
Assembly: AWSSDK.AppSync.dll
Version: 3.x.y.z
public abstract Task<CreateApiKeyResponse> CreateApiKeyAsync( CreateApiKeyRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the CreateApiKey service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| ApiKeyLimitExceededException | The API key exceeded a limit. Try your request again. |
| ApiKeyValidityOutOfBoundsException | The API key expiration must be set to a value between 1 and 365 days from creation (for CreateApiKey) or from update (for UpdateApiKey). |
| BadRequestException | The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again. |
| InternalFailureException | An internal AppSync error occurred. Try your request again. |
| LimitExceededException | The request exceeded a limit. Try your request again. |
| NotFoundException | The resource specified in the request was not found. Check the resource, and then try again. |
| UnauthorizedException | You aren't authorized to perform this operation. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5