LISTNOTEBOOKMETADATA()`¶

About ListNotebookMetadata¶

Displays the notebook files for the specified workgroup in paginated format.

Method Signature¶

METHODS /AWS1/IF_ATH~LISTNOTEBOOKMETADATA
  IMPORTING
    !IO_FILTERS TYPE REF TO /AWS1/CL_ATHFILTERDEFINITION OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ATHTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ATHMAXNOTEBOOKSCOUNT OPTIONAL
    !IV_WORKGROUP TYPE /AWS1/ATHWORKGROUPNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_athlistnotebookmetout
  RAISING
    /AWS1/CX_ATHINTERNALSERVEREX
    /AWS1/CX_ATHINVALIDREQUESTEX
    /AWS1/CX_ATHTOOMANYREQUESTSEX
    /AWS1/CX_ATHCLIENTEXC
    /AWS1/CX_ATHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workgroup` `TYPE /AWS1/ATHWORKGROUPNAME` `/AWS1/ATHWORKGROUPNAME`¶

The name of the Spark enabled workgroup to retrieve notebook metadata for.

Optional arguments:¶

`io_filters` `TYPE REF TO /AWS1/CL_ATHFILTERDEFINITION` `/AWS1/CL_ATHFILTERDEFINITION`¶

Search filter string.

`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.

`iv_maxresults` `TYPE /AWS1/ATHMAXNOTEBOOKSCOUNT` `/AWS1/ATHMAXNOTEBOOKSCOUNT`¶

Specifies the maximum number of results to return.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_athlistnotebookmetout` `/AWS1/CL_ATHLISTNOTEBOOKMETOUT`¶

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->listnotebookmetadata(
  io_filters = new /aws1/cl_athfilterdefinition( |string| )
  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.
  lv_token = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_notebookmetadatalist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_notebookid = lo_row_1->get_notebookid( ).
      lv_notebookname = lo_row_1->get_name( ).
      lv_workgroupname = lo_row_1->get_workgroup( ).
      lv_date = lo_row_1->get_creationtime( ).
      lv_notebooktype = lo_row_1->get_type( ).
      lv_date = lo_row_1->get_lastmodifiedtime( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_ATH=>LISTNOTEBOOKMETADATA()¶