LISTWORKGROUPS()`¶

About ListWorkGroups¶

Lists available workgroups for the account.

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/ATHMAXWORKGROUPSCOUNT` `/AWS1/ATHMAXWORKGROUPSCOUNT`¶

The maximum number of workgroups to return in this request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_athlistworkgroupsout` `/AWS1/CL_ATHLISTWORKGROUPSOUT`¶

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~listworkgroups(
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

LOOP AT lo_result->get_workgroups( ) into lo_row.
  lv_workgroupname = lo_row_1->get_name( ).
  lv_workgroupstate = lo_row_1->get_state( ).
  lv_workgroupdescriptionstr = lo_row_1->get_description( ).
  lv_date = lo_row_1->get_creationtime( ).
  lv_namestring = lo_engineversion->get_selectedengineversion( ).
  lv_namestring = lo_engineversion->get_effectiveengineversion( ).
  lv_identitycenterapplicati = lo_row_1->get_idcenterapplicationarn( ).
ENDLOOP.
lv_token = lo_result->get_nexttoken( ).

/AWS1/CL_ATH=>LISTWORKGROUPS()¶