DELETEKEY()`¶

About DeleteKey¶

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

For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.

Method Signature¶

METHODS /AWS1/IF_LOC~DELETEKEY
  IMPORTING
    !IV_KEYNAME TYPE /AWS1/LOCRESOURCENAME OPTIONAL
    !IV_FORCEDELETE TYPE /AWS1/LOCBOOLEAN OPTIONAL
  PREFERRED PARAMETER iv_keyname
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_locdeletekeyresponse
  RAISING
    /AWS1/CX_LOCACCESSDENIEDEX
    /AWS1/CX_LOCINTERNALSERVEREX
    /AWS1/CX_LOCRESOURCENOTFOUNDEX
    /AWS1/CX_LOCTHROTTLINGEX
    /AWS1/CX_LOCVALIDATIONEX
    /AWS1/CX_LOCCLIENTEXC
    /AWS1/CX_LOCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_keyname` `TYPE /AWS1/LOCRESOURCENAME` `/AWS1/LOCRESOURCENAME`¶

The name of the API key to delete.

Optional arguments:¶

`iv_forcedelete` `TYPE /AWS1/LOCBOOLEAN` `/AWS1/LOCBOOLEAN`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_locdeletekeyresponse` `/AWS1/CL_LOCDELETEKEYRESPONSE`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->deletekey(
  iv_forcedelete = ABAP_TRUE
  iv_keyname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_LOC=>DELETEKEY()¶