Struct ApiKey

pub struct ApiKey {
    pub description: Option<String>,
    pub expires: Option<i64>,
    pub id: Option<String>,
}

Describes an API key.

Customers invoke AWS AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:

da1: This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that date.

• 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 Amazon 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 will delete these keys from the table after February 21, 2018.

da2: This version was introduced in February 2018 when AppSync added support to extend key expiration.

• ListApiKeys returns the expiration time in seconds.

• CreateApiKey returns the expiration time in seconds and accepts a user-provided expiration time in seconds.

• UpdateApiKey returns the expiration time in seconds and accepts a user-provided expiration time in seconds. Key expiration can only be updated while the key has not expired.

• DeleteApiKey deletes the item from the table.

• Expiration is stored in Amazon DynamoDB as seconds.

Fields

description: Option<String>

A description of the purpose of the API key.

expires: Option<i64>

The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

id: Option<String>

The API key ID.

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> ApiKey

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ApiKey

fn default() -> ApiKey

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ApiKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ApiKey

fn eq(&self, other: &ApiKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ApiKey