LISTCOLLECTIONS()`¶

About ListCollections¶

Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Make sure to include an empty request body {} if you don't include any collection filters in the request.

Method Signature¶

METHODS /AWS1/IF_OSS~LISTCOLLECTIONS
  IMPORTING
    !IO_COLLECTIONFILTERS TYPE REF TO /AWS1/CL_OSSCOLLECTIONFILTERS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/OSSSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/OSSINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osslistcollsresponse
  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:¶

`io_collectionfilters` `TYPE REF TO /AWS1/CL_OSSCOLLECTIONFILTERS` `/AWS1/CL_OSSCOLLECTIONFILTERS`¶

A list of filter names and values that you can use for requests.

`iv_nexttoken` `TYPE /AWS1/OSSSTRING` `/AWS1/OSSSTRING`¶

If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

`iv_maxresults` `TYPE /AWS1/OSSINTEGER` `/AWS1/OSSINTEGER`¶

The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_osslistcollsresponse` `/AWS1/CL_OSSLISTCOLLSRESPONSE`¶

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->listcollections(
  io_collectionfilters = new /aws1/cl_osscollectionfilters(
    iv_name = |string|
    iv_status = |string|
  )
  iv_maxresults = 123
  iv_nexttoken = |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_collectionsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_collectionid = lo_row_1->get_id( ).
      lv_collectionname = lo_row_1->get_name( ).
      lv_collectionstatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_arn( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_OSS=>LISTCOLLECTIONS()¶