Skip to content

/AWS1/IF_OSS=>CREATECOLLECTION()

About CreateCollection

Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Method Signature

METHODS /AWS1/IF_OSS~CREATECOLLECTION
  IMPORTING
    !IV_NAME TYPE /AWS1/OSSCOLLECTIONNAME OPTIONAL
    !IV_TYPE TYPE /AWS1/OSSCOLLECTIONTYPE OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/OSSSTRING OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_OSSTAG=>TT_TAGS OPTIONAL
    !IV_STANDBYREPLICAS TYPE /AWS1/OSSSTANDBYREPLICAS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/OSSCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osscreatecollresponse
  RAISING
    /AWS1/CX_OSSCONFLICTEXCEPTION
    /AWS1/CX_OSSINTERNALSERVEREX
    /AWS1/CX_OSSOCULIMITEXCEEDEDEX
    /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/OSSCOLLECTIONNAME /AWS1/OSSCOLLECTIONNAME

Name of the collection.

Optional arguments:

iv_type TYPE /AWS1/OSSCOLLECTIONTYPE /AWS1/OSSCOLLECTIONTYPE

The type of collection.

iv_description TYPE /AWS1/OSSSTRING /AWS1/OSSSTRING

Description of the collection.

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.

iv_standbyreplicas TYPE /AWS1/OSSSTANDBYREPLICAS /AWS1/OSSSTANDBYREPLICAS

Indicates whether standby replicas should be used for a 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_osscreatecollresponse /AWS1/CL_OSSCREATECOLLRESPONSE

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->createcollection(
  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|
  iv_type = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_createcollectiondetail = lo_result->get_createcollectiondetail( ).
  IF lo_createcollectiondetail IS NOT INITIAL.
    lv_collectionid = lo_createcollectiondetail->get_id( ).
    lv_collectionname = lo_createcollectiondetail->get_name( ).
    lv_collectionstatus = lo_createcollectiondetail->get_status( ).
    lv_collectiontype = lo_createcollectiondetail->get_type( ).
    lv_string = lo_createcollectiondetail->get_description( ).
    lv_string = lo_createcollectiondetail->get_arn( ).
    lv_string = lo_createcollectiondetail->get_kmskeyarn( ).
    lv_standbyreplicas = lo_createcollectiondetail->get_standbyreplicas( ).
    lv_long = lo_createcollectiondetail->get_createddate( ).
    lv_long = lo_createcollectiondetail->get_lastmodifieddate( ).
  ENDIF.
ENDIF.