Skip to content

/AWS1/IF_ORG=>LISTPOLICIES()

About ListPolicies

Retrieves the list of all policies in an organization of a specified type.

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

You can only call this operation from the management account or a member account that is a delegated administrator.

Method Signature

METHODS /AWS1/IF_ORG~LISTPOLICIES
  IMPORTING
    !IV_FILTER TYPE /AWS1/ORGPOLICYTYPE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ORGNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ORGMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_orglistpolresponse
  RAISING
    /AWS1/CX_ORGACCESSDENIEDEX
    /AWS1/CX_ORGAWSORGSNOTINUSEEX
    /AWS1/CX_ORGINVALIDINPUTEX
    /AWS1/CX_ORGSERVICEEXCEPTION
    /AWS1/CX_ORGTOOMANYREQUESTSEX
    /AWS1/CX_ORGUNSUPPEDAPIENDPTEX
    /AWS1/CX_ORGCLIENTEXC
    /AWS1/CX_ORGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_filter TYPE /AWS1/ORGPOLICYTYPE /AWS1/ORGPOLICYTYPE

Specifies the type of policy that you want to include in the response. You must specify one of the following values:

Optional arguments:

iv_nexttoken TYPE /AWS1/ORGNEXTTOKEN /AWS1/ORGNEXTTOKEN

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

iv_maxresults TYPE /AWS1/ORGMAXRESULTS /AWS1/ORGMAXRESULTS

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

RETURNING

oo_output TYPE REF TO /aws1/cl_orglistpolresponse /AWS1/CL_ORGLISTPOLRESPONSE

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_filter = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_id( ).
      lv_policyarn = lo_row_1->get_arn( ).
      lv_policyname = lo_row_1->get_name( ).
      lv_policydescription = lo_row_1->get_description( ).
      lv_policytype = lo_row_1->get_type( ).
      lv_awsmanagedpolicy = lo_row_1->get_awsmanaged( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

To retrieve a list policies in the organization

The following example shows how to get a list of service control policies (SCPs):/n/n

DATA(lo_result) = lo_client->listpolicies( iv_filter = |SERVICE_CONTROL_POLICY| ) .