/AWS1/IF_OSS=>CREATECOLLECTIONGROUP()

About CreateCollectionGroup

Creates a collection group within OpenSearch Serverless. Collection groups let you manage OpenSearch Compute Units (OCUs) at a group level, with multiple collections sharing the group's capacity limits.

For more information, see Managing collection groups.

Method Signature

METHODS /AWS1/IF_OSS~CREATECOLLECTIONGROUP
  IMPORTING
    !IV_NAME TYPE /AWS1/OSSCOLLECTIONGROUPNAME OPTIONAL
    !IV_STANDBYREPLICAS TYPE /AWS1/OSSSTANDBYREPLICAS OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/OSSSTRING OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_OSSTAG=>TT_TAGS OPTIONAL
    !IO_CAPACITYLIMITS TYPE REF TO /AWS1/CL_OSSCOLLGROUPCAPLIMITS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/OSSCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osscreatecollgrouprsp
  RAISING
    /AWS1/CX_OSSCONFLICTEXCEPTION
    /AWS1/CX_OSSINTERNALSERVEREX
    /AWS1/CX_OSSSERVICEQUOTAEXCDEX
    /AWS1/CX_OSSVALIDATIONEX
    /AWS1/CX_OSSCLIENTEXC
    /AWS1/CX_OSSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/OSSCOLLECTIONGROUPNAME /AWS1/OSSCOLLECTIONGROUPNAME

The name of the collection group.

iv_standbyreplicas TYPE /AWS1/OSSSTANDBYREPLICAS /AWS1/OSSSTANDBYREPLICAS

Indicates whether standby replicas should be used for a collection group.

Optional arguments:

iv_description TYPE /AWS1/OSSSTRING /AWS1/OSSSTRING

A description of the collection group.

it_tags TYPE /AWS1/CL_OSSTAG=>TT_TAGS TT_TAGS

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection group.

io_capacitylimits TYPE REF TO /AWS1/CL_OSSCOLLGROUPCAPLIMITS /AWS1/CL_OSSCOLLGROUPCAPLIMITS

The capacity limits for the collection group, in OpenSearch Compute Units (OCUs). These limits control the maximum and minimum capacity for collections within the group.

iv_clienttoken TYPE /AWS1/OSSCLIENTTOKEN /AWS1/OSSCLIENTTOKEN

Unique, case-sensitive identifier to ensure idempotency of the request.

RETURNING

oo_output TYPE REF TO /aws1/cl_osscreatecollgrouprsp /AWS1/CL_OSSCREATECOLLGROUPRSP

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->createcollectiongroup(
  io_capacitylimits = new /aws1/cl_osscollgroupcaplimits(
    iv_maxindexingcapacityinocu = '0.1'
    iv_maxsearchcapacityinocu = '0.1'
    iv_minindexingcapacityinocu = '0.1'
    iv_minsearchcapacityinocu = '0.1'
  )
  it_tags = VALUE /aws1/cl_osstag=>tt_tags(
    (
      new /aws1/cl_osstag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_name = |string|
  iv_standbyreplicas = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_createcollectiongroupde = lo_result->get_createcollgroupdetail( ).
  IF lo_createcollectiongroupde IS NOT INITIAL.
    lv_collectiongroupid = lo_createcollectiongroupde->get_id( ).
    lv_string = lo_createcollectiongroupde->get_arn( ).
    lv_collectiongroupname = lo_createcollectiongroupde->get_name( ).
    lv_standbyreplicas = lo_createcollectiongroupde->get_standbyreplicas( ).
    lv_string = lo_createcollectiongroupde->get_description( ).
    LOOP AT lo_createcollectiongroupde->get_tags( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_tagkey = lo_row_1->get_key( ).
        lv_tagvalue = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_long = lo_createcollectiongroupde->get_createddate( ).
    lo_collectiongroupcapacity = lo_createcollectiongroupde->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.
  ENDIF.
ENDIF.