:doc:`APIGateway <../../apigateway>` / Client / get_usage_plan_keys

*******************
get_usage_plan_keys
*******************



.. py:method:: APIGateway.Client.get_usage_plan_keys(**kwargs)

  

  Gets all the usage plan keys representing the API keys added to a specified usage plan.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/GetUsagePlanKeys>`_  


  **Request Syntax**
  ::

    response = client.get_usage_plan_keys(
        usagePlanId='string',
        position='string',
        limit=123,
        nameQuery='string'
    )
    
  :type usagePlanId: string
  :param usagePlanId: **[REQUIRED]** 

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

    

  
  :type position: string
  :param position: 

    The current pagination position in the paged result set.

    

  
  :type limit: integer
  :param limit: 

    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

    

  
  :type nameQuery: string
  :param nameQuery: 

    A query parameter specifying the name of the to-be-returned usage plan keys.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'position': 'string',
          'items': [
              {
                  'id': 'string',
                  'type': 'string',
                  'value': 'string',
                  'name': '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.

      
      

      - **position** *(string) --* 
      

      - **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.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`APIGateway.Client.exceptions.BadRequestException`

  
  *   :py:class:`APIGateway.Client.exceptions.NotFoundException`

  
  *   :py:class:`APIGateway.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`APIGateway.Client.exceptions.TooManyRequestsException`

  