APIGateway / Client / get_api_keys

get_api_keys#

APIGateway.Client.get_api_keys(**kwargs)#

Gets information about the current ApiKeys resource.

See also: AWS API Documentation

Request Syntax

response = client.get_api_keys(
    position='string',
    limit=123,
    nameQuery='string',
    customerId='string',
    includeValues=True|False
)
Parameters:

  • position (string) – The current pagination position in the paged result set.

  • limit (integer) – The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

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

  • customerId (string) – The identifier of a customer in Amazon Web Services 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.

Return type:

dict

Returns:

Response Syntax

{
    'warnings': [
        'string',
    ],
    'position': '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'
            }
        },
    ]
}

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

    • position (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 Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services 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) –

Exceptions