Api Gateway  >  Operations  >  delete_api_key

delete_api_key

Operation

delete_api_key async

delete_api_key(input: DeleteApiKeyInput, plugins: list[Plugin] | None = None) -> DeleteApiKeyOutput

Deletes the ApiKey resource.

Parameters:

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

Input

DeleteApiKeyInput dataclass

A request to delete the ApiKey resource.

Attributes

api_key class-attribute instance-attribute

api_key: str | None = None

The identifier of the ApiKey resource to be deleted.

Output

DeleteApiKeyOutput dataclass

Dataclass for DeleteApiKeyOutput structure.