APIGateway / Paginator / GetUsagePlanKeys


class APIGateway.Paginator.GetUsagePlanKeys#
paginator = client.get_paginator('get_usage_plan_keys')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • usagePlanId (string) –


    The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

  • nameQuery (string) – A query parameter specifying the name of the to-be-returned usage plan keys.

  • 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:



Response Syntax

    'items': [
            'id': 'string',
            'type': 'string',
            'value': 'string',
            'name': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.

    • items (list) –

      The current page of elements from this collection.

      • (dict) –

        Represents a usage plan key to identify a plan customer.

        • id (string) –

          The Id of a usage plan key.

        • type (string) –

          The type of a usage plan key. Currently, the valid key type is API_KEY.

        • value (string) –

          The value of a usage plan key.

        • name (string) –

          The name of a usage plan key.

    • NextToken (string) –

      A token to resume pagination.