/AWS1/IF_IOT=>GETBUCKETSAGGREGATION()

About GetBucketsAggregation

Aggregates on indexed data with search queries pertaining to particular fields.

Requires permission to access the GetBucketsAggregation action.

Method Signature

METHODS /AWS1/IF_IOT~GETBUCKETSAGGREGATION
  IMPORTING
    !IV_INDEXNAME TYPE /AWS1/IOTINDEXNAME OPTIONAL
    !IV_QUERYSTRING TYPE /AWS1/IOTQUERYSTRING OPTIONAL
    !IV_AGGREGATIONFIELD TYPE /AWS1/IOTAGGREGATIONFIELD OPTIONAL
    !IV_QUERYVERSION TYPE /AWS1/IOTQUERYVERSION OPTIONAL
    !IO_BUCKETSAGGREGATIONTYPE TYPE REF TO /AWS1/CL_IOTBUCKETSAGGRTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotgetbucketsaggrrsp
  RAISING
    /AWS1/CX_IOTINDEXNOTREADYEX
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDAGGREX
    /AWS1/CX_IOTINVALIDQUERYEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTRESOURCENOTFOUNDEX
    /AWS1/CX_IOTSERVICEUNAVAILEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTUNAUTHORIZEDEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_querystring TYPE /AWS1/IOTQUERYSTRING /AWS1/IOTQUERYSTRING

The search query string.

iv_aggregationfield TYPE /AWS1/IOTAGGREGATIONFIELD /AWS1/IOTAGGREGATIONFIELD

The aggregation field.

io_bucketsaggregationtype TYPE REF TO /AWS1/CL_IOTBUCKETSAGGRTYPE /AWS1/CL_IOTBUCKETSAGGRTYPE

The basic control of the response shape and the bucket aggregation type to perform.

Optional arguments:

iv_indexname TYPE /AWS1/IOTINDEXNAME /AWS1/IOTINDEXNAME

The name of the index to search.

iv_queryversion TYPE /AWS1/IOTQUERYVERSION /AWS1/IOTQUERYVERSION

The version of the query.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotgetbucketsaggrrsp /AWS1/CL_IOTGETBUCKETSAGGRRSP

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->getbucketsaggregation(
  io_bucketsaggregationtype = new /aws1/cl_iotbucketsaggrtype( new /aws1/cl_iottermsaggregation( 123 ) )
  iv_aggregationfield = |string|
  iv_indexname = |string|
  iv_querystring = |string|
  iv_queryversion = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_count = lo_result->get_totalcount( ).
  LOOP AT lo_result->get_buckets( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_bucketkeyvalue = lo_row_1->get_keyvalue( ).
      lv_count = lo_row_1->get_count( ).
    ENDIF.
  ENDLOOP.
ENDIF.