Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

delete_usage_plan_key

delete_usage_plan_key(**kwargs)

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

See also: AWS API Documentation

Request Syntax

response = client.delete_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-deleted UsagePlanKey resource representing a plan customer.

  • keyId (string) --

    [REQUIRED]

    The Id of the UsagePlanKey resource to be deleted.

Returns

None

Exceptions

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