Skip to content

Api Gateway  >  Operations  >  delete_usage_plan_key

delete_usage_plan_key

Operation

delete_usage_plan_key async 

delete_usage_plan_key(input: DeleteUsagePlanKeyInput, plugins: list[Plugin] | None = None) -> DeleteUsagePlanKeyOutput

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

Parameters:

Name Type Description Default
input DeleteUsagePlanKeyInput

An instance of DeleteUsagePlanKeyInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DeleteUsagePlanKeyOutput

An instance of DeleteUsagePlanKeyOutput.

Input

DeleteUsagePlanKeyInput dataclass

The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.

Attributes

key_id class-attribute instance-attribute 
key_id: str | None = None

The Id of the UsagePlanKey resource to be deleted.

usage_plan_id class-attribute instance-attribute 
usage_plan_id: str | None = None

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

Output

DeleteUsagePlanKeyOutput dataclass

Dataclass for DeleteUsagePlanKeyOutput structure.