/AWS1/IF_DLM=>GETLIFECYCLEPOLICIES()

About GetLifecyclePolicies

Gets summary information about all or the specified data lifecycle policies.

To get complete information about a policy, use GetLifecyclePolicy.

Method Signature

METHODS /AWS1/IF_DLM~GETLIFECYCLEPOLICIES
  IMPORTING
    !IT_POLICYIDS TYPE /AWS1/CL_DLMPOLICYIDLIST_W=>TT_POLICYIDLIST OPTIONAL
    !IV_STATE TYPE /AWS1/DLMGETTBLPLYSTATEVALUES OPTIONAL
    !IT_RESOURCETYPES TYPE /AWS1/CL_DLMRESRCTYPEVALSLST_W=>TT_RESOURCETYPEVALUESLIST OPTIONAL
    !IT_TARGETTAGS TYPE /AWS1/CL_DLMTGTTAGSFILTLIST_W=>TT_TARGETTAGSFILTERLIST OPTIONAL
    !IT_TAGSTOADD TYPE /AWS1/CL_DLMTGSTOADDFILTLIST_W=>TT_TAGSTOADDFILTERLIST OPTIONAL
    !IV_DEFAULTPOLICYTYPE TYPE /AWS1/DLMDEFAULTPOLTYPEVALUES OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dlmgetlcpolresponse
  RAISING
    /AWS1/CX_DLMINTERNALSERVEREX
    /AWS1/CX_DLMINVALIDREQUESTEX
    /AWS1/CX_DLMLIMITEXCEEDEDEX
    /AWS1/CX_DLMRESOURCENOTFOUNDEX
    /AWS1/CX_DLMCLIENTEXC
    /AWS1/CX_DLMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

it_policyids TYPE /AWS1/CL_DLMPOLICYIDLIST_W=>TT_POLICYIDLIST TT_POLICYIDLIST

The identifiers of the data lifecycle policies.

iv_state TYPE /AWS1/DLMGETTBLPLYSTATEVALUES /AWS1/DLMGETTBLPLYSTATEVALUES

The activation state.

it_resourcetypes TYPE /AWS1/CL_DLMRESRCTYPEVALSLST_W=>TT_RESOURCETYPEVALUESLIST TT_RESOURCETYPEVALUESLIST

The resource type.

it_targettags TYPE /AWS1/CL_DLMTGTTAGSFILTLIST_W=>TT_TARGETTAGSFILTERLIST TT_TARGETTAGSFILTERLIST

The target tag for a policy.

Tags are strings in the format key=value.

it_tagstoadd TYPE /AWS1/CL_DLMTGSTOADDFILTLIST_W=>TT_TAGSTOADDFILTERLIST TT_TAGSTOADDFILTERLIST

The tags to add to objects created by the policy.

Tags are strings in the format key=value.

These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.

iv_defaultpolicytype TYPE /AWS1/DLMDEFAULTPOLTYPEVALUES /AWS1/DLMDEFAULTPOLTYPEVALUES

[Default policies only] Specifies the type of default policy to get. Specify one of the following:

• VOLUME - To get only the default policy for EBS snapshots

• INSTANCE - To get only the default policy for EBS-backed AMIs

• ALL - To get all default policies

RETURNING

oo_output TYPE REF TO /aws1/cl_dlmgetlcpolresponse /AWS1/CL_DLMGETLCPOLRESPONSE

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->getlifecyclepolicies(
  it_policyids = VALUE /aws1/cl_dlmpolicyidlist_w=>tt_policyidlist(
    ( new /aws1/cl_dlmpolicyidlist_w( |string| ) )
  )
  it_resourcetypes = VALUE /aws1/cl_dlmresrctypevalslst_w=>tt_resourcetypevalueslist(
    ( new /aws1/cl_dlmresrctypevalslst_w( |string| ) )
  )
  it_tagstoadd = VALUE /aws1/cl_dlmtgstoaddfiltlist_w=>tt_tagstoaddfilterlist(
    ( new /aws1/cl_dlmtgstoaddfiltlist_w( |string| ) )
  )
  it_targettags = VALUE /aws1/cl_dlmtgttagsfiltlist_w=>tt_targettagsfilterlist(
    ( new /aws1/cl_dlmtgttagsfiltlist_w( |string| ) )
  )
  iv_defaultpolicytype = |string|
  iv_state = |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_policies( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_policyid = lo_row_1->get_policyid( ).
      lv_policydescription = lo_row_1->get_description( ).
      lv_gettablepolicystatevalu = lo_row_1->get_state( ).
      LOOP AT lo_row_1->get_tags( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_tagvalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_policytypevalues = lo_row_1->get_policytype( ).
      lv_defaultpolicy = lo_row_1->get_defaultpolicy( ).
    ENDIF.
  ENDLOOP.
ENDIF.