Skip to content

/AWS1/IF_QST=>LISTUSERSINDEXCAPACITY()

About ListUsersIndexCapacity

Lists per-user index capacity consumption for an account.

Method Signature

METHODS /AWS1/IF_QST~LISTUSERSINDEXCAPACITY
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_NAMESPACE TYPE /AWS1/QSTNAMESPACE OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_QSTUSERINDEXCAPFILTER=>TT_USERINDEXCAPACITYFILTERS OPTIONAL
    !IV_SORTBY TYPE /AWS1/QSTUSERINDEXCAPSORTBY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/QSTUSERINDEXCAPSORTORDER OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/QSTLSTUSRSIDXCAPREQMAX00 OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/QSTSTRING00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstlistusersidxcaprsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVALIDREQUESTEX
    /AWS1/CX_QSTPRECONDNOTMETEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /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 of the Amazon Web Services account that contains the index capacity data.

Optional arguments:

iv_namespace TYPE /AWS1/QSTNAMESPACE /AWS1/QSTNAMESPACE

The namespace to scope the user search to. Required when the userNameOrEmail filter is present.

it_filters TYPE /AWS1/CL_QSTUSERINDEXCAPFILTER=>TT_USERINDEXCAPACITYFILTERS TT_USERINDEXCAPACITYFILTERS

Filters to apply. Only one filter is supported per request. The userNameOrEmail and totalCapacityBytes filters are mutually exclusive.

iv_sortby TYPE /AWS1/QSTUSERINDEXCAPSORTBY /AWS1/QSTUSERINDEXCAPSORTBY

The field to sort results by.

iv_sortorder TYPE /AWS1/QSTUSERINDEXCAPSORTORDER /AWS1/QSTUSERINDEXCAPSORTORDER

The sort order for results. Defaults to DESC if not specified.

iv_maxresults TYPE /AWS1/QSTLSTUSRSIDXCAPREQMAX00 /AWS1/QSTLSTUSRSIDXCAPREQMAX00

The maximum number of results to return per page.

iv_nexttoken TYPE /AWS1/QSTSTRING00 /AWS1/QSTSTRING00

The token for the next set of results, received from a previous call.

RETURNING

oo_output TYPE REF TO /aws1/cl_qstlistusersidxcaprsp /AWS1/CL_QSTLISTUSERSIDXCAPRSP

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->listusersindexcapacity(
  it_filters = VALUE /aws1/cl_qstuserindexcapfilter=>tt_userindexcapacityfilters(
    (
      new /aws1/cl_qstuserindexcapfilter(
        io_totalcapacitybytes = new /aws1/cl_qstcapbytesrangefilt(
          iv_maxbytes = 123
          iv_minbytes = 123
        )
        io_usernameoremail = new /aws1/cl_qstusrnmoremailfilter( |string| )
      )
    )
  )
  iv_awsaccountid = |string|
  iv_maxresults = 123
  iv_namespace = |string|
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |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_users( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_userarn( ).
      lv_string = lo_row_1->get_username( ).
      lv_string = lo_row_1->get_email( ).
      lv_string = lo_row_1->get_role( ).
      lv_longvalue = lo_row_1->get_totalcapacitybytes( ).
      lv_longvalue = lo_row_1->get_totalkbcapacitybytes( ).
      lv_longvalue = lo_row_1->get_totalspacecapacitybytes( ).
      lv_integervalue = lo_row_1->get_kbcount( ).
      lv_integervalue = lo_row_1->get_spacecount( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
  lv_string = lo_result->get_requestid( ).
ENDIF.