NAME

Paws::AppSync::ApiKey

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::AppSync::ApiKey object:

  $service_obj->Method(Att1 => { Deletes => $value, ..., Id => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::AppSync::ApiKey object:

  $result = $service_obj->Method(...);
  $result->Att1->Deletes

DESCRIPTION

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 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. Key expiration time can be updated while the key is not deleted.
• "DeleteApiKey" deletes the item from the table.
• Expiration is stored in Amazon DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. But the key can be reinstated before deletion.
• Deletion is stored in Amazon DynamoDB as seconds. The key will be deleted after deletion time.

ATTRIBUTES

SEE ALSO

This class forms part of Paws, describing an object used in Paws::AppSync

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>