DESCRIBEKEY()`¶

About DescribeKey¶

Retrieves the API key resource details.

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

Method Signature¶

METHODS /AWS1/IF_LOC~DESCRIBEKEY
  IMPORTING
    !IV_KEYNAME TYPE /AWS1/LOCRESOURCENAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_locdescrkeyresponse
  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 resource.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_locdescrkeyresponse` `/AWS1/CL_LOCDESCRKEYRESPONSE`¶

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->describekey( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_apikey = lo_result->get_key( ).
  lv_arn = lo_result->get_keyarn( ).
  lv_resourcename = lo_result->get_keyname( ).
  lo_apikeyrestrictions = lo_result->get_restrictions( ).
  IF lo_apikeyrestrictions IS NOT INITIAL.
    LOOP AT lo_apikeyrestrictions->get_allowactions( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_apikeyaction = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_apikeyrestrictions->get_allowresources( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_geoarnv2 = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_apikeyrestrictions->get_allowreferers( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_refererpattern = lo_row_5->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_apikeyrestrictions->get_allowandroidapps( ) into lo_row_6.
      lo_row_7 = lo_row_6.
      IF lo_row_7 IS NOT INITIAL.
        lv_androidpackagename = lo_row_7->get_package( ).
        lv_sha1certificatefingerpr = lo_row_7->get_certificatefingerprint( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_apikeyrestrictions->get_allowappleapps( ) into lo_row_8.
      lo_row_9 = lo_row_8.
      IF lo_row_9 IS NOT INITIAL.
        lv_applebundleid = lo_row_9->get_bundleid( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
  lv_timestamp = lo_result->get_createtime( ).
  lv_timestamp = lo_result->get_expiretime( ).
  lv_timestamp = lo_result->get_updatetime( ).
  lv_resourcedescription = lo_result->get_description( ).
  LOOP AT lo_result->get_tags( ) into ls_row_10.
    lv_key = ls_row_10-key.
    lo_value = ls_row_10-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_LOC=>DESCRIBEKEY()¶