APIGateway / Client / get_usage_plan_keys

get_usage_plan_keys#

APIGateway.Client.get_usage_plan_keys(**kwargs)#

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

Request Syntax

response = client.get_usage_plan_keys(
    usagePlanId='string',
    position='string',
    limit=123,
    nameQuery='string'
)

Parameters:

usagePlanId (string) –
[REQUIRED]

The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
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) – A query parameter specifying the name of the to-be-returned usage plan keys.

Return type:

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

APIGateway.Client.exceptions.BadRequestException
APIGateway.Client.exceptions.NotFoundException
APIGateway.Client.exceptions.UnauthorizedException
APIGateway.Client.exceptions.TooManyRequestsException