Skip to content

/AWS1/IF_LKF=>LISTLFTAGS()

About ListLFTags

Lists LF-tags that the requester has permission to view.

Method Signature

METHODS /AWS1/IF_LKF~LISTLFTAGS
  IMPORTING
    !IV_CATALOGID TYPE /AWS1/LKFCATALOGIDSTRING OPTIONAL
    !IV_RESOURCESHARETYPE TYPE /AWS1/LKFRESOURCESHARETYPE OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LKFPAGESIZE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LKFTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lkflistlftagsresponse
  RAISING
    /AWS1/CX_LKFACCESSDENIEDEX
    /AWS1/CX_LKFENTITYNOTFOUNDEX
    /AWS1/CX_LKFINTERNALSERVICEEX
    /AWS1/CX_LKFINVALIDINPUTEX
    /AWS1/CX_LKFOPERATIONTIMEOUTEX
    /AWS1/CX_LKFCLIENTEXC
    /AWS1/CX_LKFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_catalogid TYPE /AWS1/LKFCATALOGIDSTRING /AWS1/LKFCATALOGIDSTRING

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

iv_resourcesharetype TYPE /AWS1/LKFRESOURCESHARETYPE /AWS1/LKFRESOURCESHARETYPE

If resource share type is ALL, returns both in-account LF-tags and shared LF-tags that the requester has permission to view. If resource share type is FOREIGN, returns all share LF-tags that the requester can view. If no resource share type is passed, lists LF-tags in the given catalog ID that the requester has permission to view.

iv_maxresults TYPE /AWS1/LKFPAGESIZE /AWS1/LKFPAGESIZE

The maximum number of results to return.

iv_nexttoken TYPE /AWS1/LKFTOKEN /AWS1/LKFTOKEN

A continuation token, if this is not the first call to retrieve this list.

RETURNING

oo_output TYPE REF TO /aws1/cl_lkflistlftagsresponse /AWS1/CL_LKFLISTLFTAGSRESPONSE

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->listlftags(
  iv_catalogid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_resourcesharetype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_lftags( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_catalogidstring = lo_row_1->get_catalogid( ).
      lv_lftagkey = lo_row_1->get_tagkey( ).
      LOOP AT lo_row_1->get_tagvalues( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_lftagvalue = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_token = lo_result->get_nexttoken( ).
ENDIF.