UPDATECOLLECTION()`¶

About UpdateCollection¶

Updates an OpenSearch Serverless collection.

Method Signature¶

METHODS /AWS1/IF_OSS~UPDATECOLLECTION
  IMPORTING
    !IV_ID TYPE /AWS1/OSSCOLLECTIONID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/OSSSTRING OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/OSSCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ossupdatecollresponse
  RAISING
    /AWS1/CX_OSSCONFLICTEXCEPTION
    /AWS1/CX_OSSINTERNALSERVEREX
    /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/OSSCOLLECTIONID` `/AWS1/OSSCOLLECTIONID`¶

The unique identifier of the collection.

Optional arguments:¶

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

A description of the collection.

`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_ossupdatecollresponse` `/AWS1/CL_OSSUPDATECOLLRESPONSE`¶

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->updatecollection(
  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_updatecollectiondetail = lo_result->get_updatecollectiondetail( ).
  IF lo_updatecollectiondetail IS NOT INITIAL.
    lv_collectionid = lo_updatecollectiondetail->get_id( ).
    lv_collectionname = lo_updatecollectiondetail->get_name( ).
    lv_collectionstatus = lo_updatecollectiondetail->get_status( ).
    lv_collectiontype = lo_updatecollectiondetail->get_type( ).
    lv_string = lo_updatecollectiondetail->get_description( ).
    lv_string = lo_updatecollectiondetail->get_arn( ).
    lv_long = lo_updatecollectiondetail->get_createddate( ).
    lv_long = lo_updatecollectiondetail->get_lastmodifieddate( ).
  ENDIF.
ENDIF.

/AWS1/IF_OSS=>UPDATECOLLECTION()¶