Skip to content

/AWS1/IF_RBN=>LISTRULES()

About ListRules

Lists the Recycle Bin retention rules in the Region.

Method Signature

METHODS /AWS1/IF_RBN~LISTRULES
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/RBNMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/RBNNEXTTOKEN OPTIONAL
    !IV_RESOURCETYPE TYPE /AWS1/RBNRESOURCETYPE OPTIONAL
    !IT_RESOURCETAGS TYPE /AWS1/CL_RBNRESOURCETAG=>TT_RESOURCETAGS OPTIONAL
    !IV_LOCKSTATE TYPE /AWS1/RBNLOCKSTATE OPTIONAL
    !IT_EXCLUDERESOURCETAGS TYPE /AWS1/CL_RBNRESOURCETAG=>TT_EXCLUDERESOURCETAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rbnlistrulesresponse
  RAISING
    /AWS1/CX_RBNINTERNALSERVEREX
    /AWS1/CX_RBNVALIDATIONEX
    /AWS1/CX_RBNCLIENTEXC
    /AWS1/CX_RBNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_resourcetype TYPE /AWS1/RBNRESOURCETYPE /AWS1/RBNRESOURCETYPE

The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

Optional arguments:

iv_maxresults TYPE /AWS1/RBNMAXRESULTS /AWS1/RBNMAXRESULTS

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

iv_nexttoken TYPE /AWS1/RBNNEXTTOKEN /AWS1/RBNNEXTTOKEN

The token for the next page of results.

it_resourcetags TYPE /AWS1/CL_RBNRESOURCETAG=>TT_RESOURCETAGS TT_RESOURCETAGS

[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

iv_lockstate TYPE /AWS1/RBNLOCKSTATE /AWS1/RBNLOCKSTATE

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

it_excluderesourcetags TYPE /AWS1/CL_RBNRESOURCETAG=>TT_EXCLUDERESOURCETAGS TT_EXCLUDERESOURCETAGS

[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

RETURNING

oo_output TYPE REF TO /aws1/cl_rbnlistrulesresponse /AWS1/CL_RBNLISTRULESRESPONSE

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->listrules(
  it_excluderesourcetags = VALUE /aws1/cl_rbnresourcetag=>tt_excluderesourcetags(
    (
      new /aws1/cl_rbnresourcetag(
        iv_resourcetagkey = |string|
        iv_resourcetagvalue = |string|
      )
    )
  )
  it_resourcetags = VALUE /aws1/cl_rbnresourcetag=>tt_resourcetags(
    (
      new /aws1/cl_rbnresourcetag(
        iv_resourcetagkey = |string|
        iv_resourcetagvalue = |string|
      )
    )
  )
  iv_lockstate = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_resourcetype = |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_rules( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_ruleidentifier = lo_row_1->get_identifier( ).
      lv_description = lo_row_1->get_description( ).
      lo_retentionperiod = lo_row_1->get_retentionperiod( ).
      IF lo_retentionperiod IS NOT INITIAL.
        lv_retentionperiodvalue = lo_retentionperiod->get_retentionperiodvalue( ).
        lv_retentionperiodunit = lo_retentionperiod->get_retentionperiodunit( ).
      ENDIF.
      lv_lockstate = lo_row_1->get_lockstate( ).
      lv_rulearn = lo_row_1->get_rulearn( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.