BATCHGETCOLLECTIONGROUP()`¶

About BatchGetCollectionGroup¶

Returns attributes for one or more collection groups, including capacity limits and the number of collections in each group. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Method Signature¶

METHODS /AWS1/IF_OSS~BATCHGETCOLLECTIONGROUP
  IMPORTING
    !IT_IDS TYPE /AWS1/CL_OSSCOLLGROUPIDS_W=>TT_COLLECTIONGROUPIDS OPTIONAL
    !IT_NAMES TYPE /AWS1/CL_OSSCOLLGROUPNAMES_W=>TT_COLLECTIONGROUPNAMES OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ossbtcgetcollgrouprsp
  RAISING
    /AWS1/CX_OSSINTERNALSERVEREX
    /AWS1/CX_OSSVALIDATIONEX
    /AWS1/CX_OSSCLIENTEXC
    /AWS1/CX_OSSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_ids` `TYPE /AWS1/CL_OSSCOLLGROUPIDS_W=>TT_COLLECTIONGROUPIDS` `TT_COLLECTIONGROUPIDS`¶

A list of collection group IDs. You can't provide names and IDs in the same request.

`it_names` `TYPE /AWS1/CL_OSSCOLLGROUPNAMES_W=>TT_COLLECTIONGROUPNAMES` `TT_COLLECTIONGROUPNAMES`¶

A list of collection group names. You can't provide names and IDs in the same request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ossbtcgetcollgrouprsp` `/AWS1/CL_OSSBTCGETCOLLGROUPRSP`¶

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->batchgetcollectiongroup(
  it_ids = VALUE /aws1/cl_osscollgroupids_w=>tt_collectiongroupids(
    ( new /aws1/cl_osscollgroupids_w( |string| ) )
  )
  it_names = VALUE /aws1/cl_osscollgroupnames_w=>tt_collectiongroupnames(
    ( new /aws1/cl_osscollgroupnames_w( |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_collectiongroupdetails( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_collectiongroupid = lo_row_1->get_id( ).
      lv_string = lo_row_1->get_arn( ).
      lv_collectiongroupname = lo_row_1->get_name( ).
      lv_standbyreplicas = lo_row_1->get_standbyreplicas( ).
      lv_string = lo_row_1->get_description( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_tagkey = lo_row_3->get_key( ).
          lv_tagvalue = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_long = lo_row_1->get_createddate( ).
      lo_collectiongroupcapacity = lo_row_1->get_capacitylimits( ).
      IF lo_collectiongroupcapacity IS NOT INITIAL.
        lv_collectiongroupindexing = lo_collectiongroupcapacity->get_maxindexingcapacityinocu( ).
        lv_collectiongroupsearchca = lo_collectiongroupcapacity->get_maxsearchcapacityinocu( ).
        lv_collectiongroupindexing = lo_collectiongroupcapacity->get_minindexingcapacityinocu( ).
        lv_collectiongroupsearchca = lo_collectiongroupcapacity->get_minsearchcapacityinocu( ).
      ENDIF.
      lv_integer = lo_row_1->get_numberofcollections( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_collgrouperrordetails( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lv_collectiongroupid = lo_row_5->get_id( ).
      lv_collectiongroupname = lo_row_5->get_name( ).
      lv_string = lo_row_5->get_errormessage( ).
      lv_string = lo_row_5->get_errorcode( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_OSS=>BATCHGETCOLLECTIONGROUP()¶