APIGateway / Paginator / GetApiKeys

GetApiKeys

class APIGateway.Paginator.GetApiKeys

paginator = client.get_paginator('get_api_keys')

paginate(**kwargs)

Creates an iterator that will paginate through responses from APIGateway.Client.get_api_keys().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    nameQuery='string',
    customerId='string',
    includeValues=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• nameQuery (string) – The name of queried API keys.

• customerId (string) – The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

• includeValues (boolean) – A boolean flag to specify whether ( true) or not ( false) the result contains key values.

• 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

{
    'warnings': [
        'string',
    ],
    'items': [
        {
            'id': 'string',
            'value': 'string',
            'name': 'string',
            'customerId': 'string',
            'description': 'string',
            'enabled': True|False,
            'createdDate': datetime(2015, 1, 1),
            'lastUpdatedDate': datetime(2015, 1, 1),
            'stageKeys': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents a collection of API keys as represented by an ApiKeys resource.

  • warnings (list) –

    A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.

    • (string) –

  • items (list) –

    The current page of elements from this collection.

    • (dict) –

      A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

      • id (string) –

        The identifier of the API Key.

      • value (string) –

        The value of the API Key.

      • name (string) –

        The name of the API Key.

      • customerId (string) –

        An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

      • description (string) –

        The description of the API Key.

      • enabled (boolean) –

        Specifies whether the API Key can be used by callers.

      • createdDate (datetime) –

        The timestamp when the API Key was created.

      • lastUpdatedDate (datetime) –

        The timestamp when the API Key was last updated.

      • stageKeys (list) –

        A list of Stage resources that are associated with the ApiKey resource.

        • (string) –

      • tags (dict) –

        The collection of tags. Each tag element is associated with a given resource.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.