LISTLIFECYCLEPOLICIES()`¶

About ListLifecyclePolicies¶

Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

Method Signature¶

METHODS /AWS1/IF_OSS~LISTLIFECYCLEPOLICIES
  IMPORTING
    !IV_TYPE TYPE /AWS1/OSSLIFECYCLEPOLICYTYPE OPTIONAL
    !IT_RESOURCES TYPE /AWS1/CL_OSSLCRESOURCEFILTER_W=>TT_LIFECYCLERESOURCEFILTER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/OSSSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/OSSINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osslistlcpolresponse
  RAISING
    /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_type` `TYPE /AWS1/OSSLIFECYCLEPOLICYTYPE` `/AWS1/OSSLIFECYCLEPOLICYTYPE`¶

The type of lifecycle policy.

Optional arguments:¶

`it_resources` `TYPE /AWS1/CL_OSSLCRESOURCEFILTER_W=>TT_LIFECYCLERESOURCEFILTER` `TT_LIFECYCLERESOURCEFILTER`¶

Resource filters that policies can apply to. Currently, the only supported resource type is index.

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

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

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

An optional parameter that specifies the maximum number of results to return. You can use use nextToken to get the next page of results. The default is 10.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_osslistlcpolresponse` `/AWS1/CL_OSSLISTLCPOLRESPONSE`¶

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->listlifecyclepolicies(
  it_resources = VALUE /aws1/cl_osslcresourcefilter_w=>tt_lifecycleresourcefilter(
    ( new /aws1/cl_osslcresourcefilter_w( |string| ) )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_type = |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_lifecyclepolicysummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_lifecyclepolicytype = lo_row_1->get_type( ).
      lv_policyname = lo_row_1->get_name( ).
      lv_policyversion = lo_row_1->get_policyversion( ).
      lv_policydescription = lo_row_1->get_description( ).
      lv_long = lo_row_1->get_createddate( ).
      lv_long = lo_row_1->get_lastmodifieddate( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_OSS=>LISTLIFECYCLEPOLICIES()¶