Api Gateway  >  Operations  >  delete_usage_plan

delete_usage_plan

Operation

delete_usage_plan async

delete_usage_plan(input: DeleteUsagePlanInput, plugins: list[Plugin] | None = None) -> DeleteUsagePlanOutput

Deletes a usage plan of a given plan Id.

Parameters:

Name	Type	Description	Default
input	DeleteUsagePlanInput	An instance of DeleteUsagePlanInput.	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
DeleteUsagePlanOutput	An instance of DeleteUsagePlanOutput.

Input

DeleteUsagePlanInput dataclass

The DELETE request to delete a usage plan of a given plan Id.

Attributes

usage_plan_id class-attribute instance-attribute

usage_plan_id: str | None = None

The Id of the to-be-deleted usage plan.

Output

DeleteUsagePlanOutput dataclass

Dataclass for DeleteUsagePlanOutput structure.