Skip to content

delete_usage_plan

Operation

delete_usage_plan

delete_usage_plan(request: DeleteUsagePlanInput | DeleteUsagePlanInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteUsagePlanInputDict]) -> DeleteUsagePlanOutput

Deletes a usage plan of a given plan Id.

Parameters:

Name Type Description Default
request DeleteUsagePlanInput | DeleteUsagePlanInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteUsagePlanInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteUsagePlanOutput

An instance of DeleteUsagePlanOutput.

delete_usage_plan async

delete_usage_plan(request: DeleteUsagePlanInput | DeleteUsagePlanInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteUsagePlanInputDict]) -> DeleteUsagePlanOutput

Deletes a usage plan of a given plan Id.

Parameters:

Name Type Description Default
request DeleteUsagePlanInput | DeleteUsagePlanInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteUsagePlanInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteUsagePlanOutput

An instance of DeleteUsagePlanOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteUsagePlanInputDict

Bases: TypedDict

Dictionary form of DeleteUsagePlanInput.

Attributes

usage_plan_id instance-attribute
usage_plan_id: Required[str]

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

DeleteUsagePlanInput dataclass

Bases: _SerdeShape

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 = ...

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

Output

DeleteUsagePlanOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteUsagePlanOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.