APIGateway / Client / get_usage_plan_key

get_usage_plan_key

APIGateway.Client.get_usage_plan_key(**kwargs)

Gets a usage plan key of a given key identifier.

See also: AWS API Documentation

Request Syntax

response = client.get_usage_plan_key(
    usagePlanId='string',
    keyId='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.

• keyId (string) –

  [REQUIRED]

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

Return type:

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

• APIGateway.Client.exceptions.BadRequestException

• APIGateway.Client.exceptions.NotFoundException

• APIGateway.Client.exceptions.UnauthorizedException

• APIGateway.Client.exceptions.TooManyRequestsException