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

******************
get_usage_plan_key
******************



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

  

  Gets a usage plan key of a given key identifier.

  

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


  **Request Syntax**
  ::

    response = client.get_usage_plan_key(
        usagePlanId='string',
        keyId='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 keyId: string
  :param keyId: **[REQUIRED]** 

    The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

    

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

    
    ::

      {
          'id': 'string',
          'type': 'string',
          'value': 'string',
          'name': 'string'
      }
      
    **Response Structure**

    

    - *(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`

  