LISTPOLICIES()`¶

About ListPolicies¶

Retrieves a list of policies within the AgentCore Policy engine. This operation supports pagination and filtering to help administrators manage and discover policies across policy engines. Results can be filtered by policy engine or resource associations.

Method Signature¶

METHODS /AWS1/IF_BDO~LISTPOLICIES
  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_bdolistpolresponse
  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 policies to retrieve.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/BDONEXTTOKEN` `/AWS1/BDONEXTTOKEN`¶

A pagination token returned from a previous ListPolicies 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 policies to return in a single response. If not specified, the default is 10 policies per page, with a maximum of 100 per page.

`iv_targetresourcescope` `TYPE /AWS1/BDOBDRKAGENTCORERESARN` `/AWS1/BDOBDRKAGENTCORERESARN`¶

Optional filter to list policies that apply to a specific resource scope or resource type. This helps narrow down policy 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_bdolistpolresponse` `/AWS1/CL_BDOLISTPOLRESPONSE`¶

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->listpolicies(
  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( ).
      lo_policydefinition = lo_row_1->get_definition( ).
      IF lo_policydefinition IS NOT INITIAL.
        lo_cedarpolicy = lo_policydefinition->get_cedar( ).
        IF lo_cedarpolicy IS NOT INITIAL.
          lv_statement = lo_cedarpolicy->get_statement( ).
        ENDIF.
      ENDIF.
      lv_description = lo_row_1->get_description( ).
      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( ).
      LOOP AT lo_row_1->get_statusreasons( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_BDO=>LISTPOLICIES()¶