Skip to content

/AWS1/IF_BDO=>LISTPOLICYSUMMARIES()

About ListPolicySummaries

Retrieves a paginated list of metadata-only policy summaries within a policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy, but does not include policy definitions, descriptions, or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

Method Signature

METHODS /AWS1/IF_BDO~LISTPOLICYSUMMARIES
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/BDONEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BDOMAXRESULTS OPTIONAL
    !IV_POLICYENGINEID TYPE /AWS1/BDORESOURCEID OPTIONAL
    !IV_TARGETRESOURCESCOPE TYPE /AWS1/BDOBDRKAGENTCORERESARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdolistpolicysumsrsp
  RAISING
    /AWS1/CX_BDOACCESSDENIEDEX
    /AWS1/CX_BDOINTERNALSERVEREX
    /AWS1/CX_BDORESOURCENOTFOUNDEX
    /AWS1/CX_BDOTHROTTLINGEX
    /AWS1/CX_BDOVALIDATIONEX
    /AWS1/CX_BDOCLIENTEXC
    /AWS1/CX_BDOSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_policyengineid TYPE /AWS1/BDORESOURCEID /AWS1/BDORESOURCEID

The identifier of the policy engine whose policy summaries to retrieve.

Optional arguments:

iv_nexttoken TYPE /AWS1/BDONEXTTOKEN /AWS1/BDONEXTTOKEN

A pagination token returned from a previous ListPolicySummaries call. Use this token to retrieve the next page of results when the response is paginated.

iv_maxresults TYPE /AWS1/BDOMAXRESULTS /AWS1/BDOMAXRESULTS

The maximum number of policy summaries to return in a single response.

iv_targetresourcescope TYPE /AWS1/BDOBDRKAGENTCORERESARN /AWS1/BDOBDRKAGENTCORERESARN

Optional filter to list policy summaries that apply to a specific resource scope or resource type. This helps narrow down results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdolistpolicysumsrsp /AWS1/CL_BDOLISTPOLICYSUMSRSP

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->listpolicysummaries(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_policyengineid = |string|
  iv_targetresourcescope = |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_resourceid = lo_row_1->get_policyid( ).
      lv_policyname = lo_row_1->get_name( ).
      lv_resourceid = lo_row_1->get_policyengineid( ).
      lv_datetimestamp = lo_row_1->get_createdat( ).
      lv_datetimestamp = lo_row_1->get_updatedat( ).
      lv_policyarn = lo_row_1->get_policyarn( ).
      lv_policystatus = lo_row_1->get_status( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.