Skip to content

/AWS1/CL_ATH=>LISTDATACATALOGS()

About ListDataCatalogs

Lists the data catalogs in the current Amazon Web Services account.

In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.

Method Signature

IMPORTING

Optional arguments:

iv_nexttoken TYPE /AWS1/ATHTOKEN /AWS1/ATHTOKEN

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

iv_maxresults TYPE /AWS1/ATHMAXDATACATALOGSCOUNT /AWS1/ATHMAXDATACATALOGSCOUNT

Specifies the maximum number of data catalogs to return.

iv_workgroup TYPE /AWS1/ATHWORKGROUPNAME /AWS1/ATHWORKGROUPNAME

The name of the workgroup. Required if making an IAM Identity Center request.

RETURNING

oo_output TYPE REF TO /aws1/cl_athlstdatacatalogsout /AWS1/CL_ATHLSTDATACATALOGSOUT

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->/aws1/if_ath~listdatacatalogs(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_workgroup = |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_datacatalogssummary( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_catalognamestring = lo_row_1->get_catalogname( ).
      lv_datacatalogtype = lo_row_1->get_type( ).
      lv_datacatalogstatus = lo_row_1->get_status( ).
      lv_connectiontype = lo_row_1->get_connectiontype( ).
      lv_errormessage = lo_row_1->get_error( ).
    ENDIF.
  ENDLOOP.
  lv_token = lo_result->get_nexttoken( ).
ENDIF.