SEARCHGROUPS()`¶

About SearchGroups¶

Use the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters.

Method Signature¶

METHODS /AWS1/IF_QST~SEARCHGROUPS
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/QSTSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/QSTMAXRESULTS OPTIONAL
    !IV_NAMESPACE TYPE /AWS1/QSTNAMESPACE OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_QSTGROUPSEARCHFILTER=>TT_GROUPSEARCHFILTERLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstsearchgroupsrsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVALIDNEXTTOKENEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTPRECONDNOTMETEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTRESOURCEUNAVAILEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_awsaccountid` `TYPE /AWS1/QSTAWSACCOUNTID` `/AWS1/QSTAWSACCOUNTID`¶

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.

`iv_namespace` `TYPE /AWS1/QSTNAMESPACE` `/AWS1/QSTNAMESPACE`¶

The namespace that you want to search.

`it_filters` `TYPE /AWS1/CL_QSTGROUPSEARCHFILTER=>TT_GROUPSEARCHFILTERLIST` `TT_GROUPSEARCHFILTERLIST`¶

The structure for the search filters that you want to apply to your search.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/QSTSTRING` `/AWS1/QSTSTRING`¶

A pagination token that can be used in a subsequent request.

`iv_maxresults` `TYPE /AWS1/QSTMAXRESULTS` `/AWS1/QSTMAXRESULTS`¶

The maximum number of results to return from this request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstsearchgroupsrsp` `/AWS1/CL_QSTSEARCHGROUPSRSP`¶

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->searchgroups(
  it_filters = VALUE /aws1/cl_qstgroupsearchfilter=>tt_groupsearchfilterlist(
    (
      new /aws1/cl_qstgroupsearchfilter(
        iv_name = |string|
        iv_operator = |string|
        iv_value = |string|
      )
    )
  )
  iv_awsaccountid = |string|
  iv_maxresults = 123
  iv_namespace = |string|
  iv_nexttoken = |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_grouplist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_arn = lo_row_1->get_arn( ).
      lv_groupname = lo_row_1->get_groupname( ).
      lv_groupdescription = lo_row_1->get_description( ).
      lv_string = lo_row_1->get_principalid( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
  lv_string = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.

/AWS1/IF_QST=>SEARCHGROUPS()¶