Skip to content

delete_usage_plan_key

Operation

delete_usage_plan_key

delete_usage_plan_key(request: DeleteUsagePlanKeyInput | DeleteUsagePlanKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteUsagePlanKeyInputDict]) -> DeleteUsagePlanKeyOutput

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

Parameters:

Name Type Description Default
request DeleteUsagePlanKeyInput | DeleteUsagePlanKeyInputDict | 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[DeleteUsagePlanKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteUsagePlanKeyOutput

An instance of DeleteUsagePlanKeyOutput.

delete_usage_plan_key async

delete_usage_plan_key(request: DeleteUsagePlanKeyInput | DeleteUsagePlanKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteUsagePlanKeyInputDict]) -> DeleteUsagePlanKeyOutput

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

Parameters:

Name Type Description Default
request DeleteUsagePlanKeyInput | DeleteUsagePlanKeyInputDict | 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[DeleteUsagePlanKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteUsagePlanKeyOutput

An instance of DeleteUsagePlanKeyOutput.

Input

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

DeleteUsagePlanKeyInputDict

Bases: TypedDict

Dictionary form of DeleteUsagePlanKeyInput.

Attributes

key_id instance-attribute
key_id: Required[str]

The Id of the UsagePlanKey resource to be deleted.

usage_plan_id instance-attribute
usage_plan_id: Required[str]

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

DeleteUsagePlanKeyInput dataclass

Bases: _SerdeShape

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

The Id of the UsagePlanKey resource to be deleted.

usage_plan_id class-attribute instance-attribute
usage_plan_id: str | 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

Bases: _SerdeShape

Dataclass for DeleteUsagePlanKeyOutput 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.