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.
Describes an API key.
Customers invoke AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:
da1: We introduced this version at launch in November 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid after February 21, 2018, and they should no longer be used.
ListApiKeys
returns the expiration time in milliseconds.
CreateApiKey
returns the expiration time in milliseconds.
UpdateApiKey
is not available for this key version.
DeleteApiKey
deletes the item from the table.
Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we deleted these keys from the table on February 21, 2018.
da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.
ListApiKeys
returns the expiration time and deletion time in seconds.
CreateApiKey
returns the expiration time and deletion time in seconds and
accepts a user-provided expiration time in seconds.
UpdateApiKey
returns the expiration time and and deletion time in seconds
and accepts a user-provided expiration time in seconds. Expired API keys are kept
for 60 days after the expiration time. You can update the key expiration time as long
as the key isn't deleted.
DeleteApiKey
deletes the item from the table.
Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. However, you can reinstate the key before deletion.
Deletion is stored in DynamoDB as seconds. The key is deleted after deletion time.
Namespace: Amazon.AppSync.Model
Assembly: AWSSDK.AppSync.dll
Version: 3.x.y.z
public class ApiKey
The ApiKey type exposes the following members
Name | Description | |
---|---|---|
ApiKey() |
Name | Type | Description | |
---|---|---|---|
Deletes | System.Int64 |
Gets and sets the property Deletes. The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour. |
|
Description | System.String |
Gets and sets the property Description. A description of the purpose of the API key. |
|
Expires | System.Int64 |
Gets and sets the property Expires. The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. |
|
Id | System.String |
Gets and sets the property Id. The API key ID. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5