AppSync / Paginator / ListApiKeys

ListApiKeys

class AppSync.Paginator.ListApiKeys

paginator = client.get_paginator('list_api_keys')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AppSync.Client.list_api_keys().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    apiId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• apiId (string) –

  [REQUIRED]

  The API ID.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.