UPDATECOLLECTIONGROUP()`¶

About UpdateCollectionGroup¶

Updates the description and capacity limits of a collection group.

Method Signature¶

METHODS /AWS1/IF_OSS~UPDATECOLLECTIONGROUP
  IMPORTING
    !IV_ID TYPE /AWS1/OSSCOLLECTIONGROUPID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/OSSSTRING 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_ossupdatecollgrouprsp
  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_id` `TYPE /AWS1/OSSCOLLECTIONGROUPID` `/AWS1/OSSCOLLECTIONGROUPID`¶

The unique identifier of the collection group to update.

Optional arguments:¶

`iv_description` `TYPE /AWS1/OSSSTRING` `/AWS1/OSSSTRING`¶

A new description for the collection group.

`io_capacitylimits` `TYPE REF TO /AWS1/CL_OSSCOLLGROUPCAPLIMITS` `/AWS1/CL_OSSCOLLGROUPCAPLIMITS`¶

Updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs).

`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_ossupdatecollgrouprsp` `/AWS1/CL_OSSUPDATECOLLGROUPRSP`¶

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->updatecollectiongroup(
  io_capacitylimits = new /aws1/cl_osscollgroupcaplimits(
    iv_maxindexingcapacityinocu = '0.1'
    iv_maxsearchcapacityinocu = '0.1'
    iv_minindexingcapacityinocu = '0.1'
    iv_minsearchcapacityinocu = '0.1'
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_id = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_updatecollectiongroupde = lo_result->get_updatecollgroupdetail( ).
  IF lo_updatecollectiongroupde IS NOT INITIAL.
    lv_collectiongroupid = lo_updatecollectiongroupde->get_id( ).
    lv_string = lo_updatecollectiongroupde->get_arn( ).
    lv_collectiongroupname = lo_updatecollectiongroupde->get_name( ).
    lv_string = lo_updatecollectiongroupde->get_description( ).
    lo_collectiongroupcapacity = lo_updatecollectiongroupde->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_long = lo_updatecollectiongroupde->get_createddate( ).
    lv_long = lo_updatecollectiongroupde->get_lastmodifieddate( ).
  ENDIF.
ENDIF.

/AWS1/IF_OSS=>UPDATECOLLECTIONGROUP()¶