LocationService / Client / delete_key

delete_key#

LocationService.Client.delete_key(**kwargs)#

Deletes the specified API key. The API key must have been deactivated more than 90 days previously.

See also: AWS API Documentation

Request Syntax

response = client.delete_key(
    ForceDelete=True|False,
    KeyName='string'
)
Parameters:

  • ForceDelete (boolean) –

    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

    Note

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

  • KeyName (string) –

    [REQUIRED]

    The name of the API key to delete.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions