Skip to content

DeleteKeyRequest

Source code in docs_src/capo_location/types/delete_key_request.py 
11
12
13
14
15
class DeleteKeyRequest(TypedDict, closed=True):
    key_name: "capo_location.types.resource_name.ResourceName"
    """<p>The name of the API key to delete.</p>"""
    force_delete: NotRequired["bool"]
    """<p>ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter <code>true</code> to delete the key or to <code>false</code> to not preemptively delete the API key.</p> <p>Valid values: <code>true</code>, or <code>false</code>.</p> <p>Required: No</p> <note> <p>This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.</p> </note>"""

force_delete instance-attribute 

force_delete: NotRequired[bool]

ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

key_name instance-attribute 

key_name: ResourceName

The name of the API key to delete.