AppSync / Client / list_api_keys

list_api_keys#

AppSync.Client.list_api_keys(**kwargs)#

Lists the API keys for a given API.

Note

API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it’s automatically deleted.

See also: AWS API Documentation

Request Syntax

response = client.list_api_keys(
    apiId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • apiId (string) –

    [REQUIRED]

    The API ID.

  • nextToken (string) – An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

  • maxResults (integer) – The maximum number of results that you want the request to return.

Return type:

dict

Returns:

Response Syntax

{
    'apiKeys': [
        {
            'id': 'string',
            'description': 'string',
            'expires': 123,
            'deletes': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • apiKeys (list) –

      The ApiKey objects.

      • (dict) –

        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.

        • id (string) –

          The API key ID.

        • description (string) –

          A description of the purpose of the API key.

        • expires (integer) –

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

        • deletes (integer) –

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

    • nextToken (string) –

      An identifier to pass in the next request to this operation to return the next set of items in the list.

Exceptions

  • AppSync.Client.exceptions.BadRequestException

  • AppSync.Client.exceptions.NotFoundException

  • AppSync.Client.exceptions.UnauthorizedException

  • AppSync.Client.exceptions.InternalFailureException