Skip to content

/AWS1/CL_IAM=>LISTENTITIESFORPOLICY()

About ListEntitiesForPolicy

Lists all IAM users, groups, and roles that the specified managed policy is attached to.

You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role.

You can paginate the results using the MaxItems and Marker parameters.

Method Signature

IMPORTING

Required arguments:

iv_policyarn TYPE /AWS1/IAMARNTYPE /AWS1/IAMARNTYPE

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Optional arguments:

iv_entityfilter TYPE /AWS1/IAMENTITYTYPE /AWS1/IAMENTITYTYPE

The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.

iv_pathprefix TYPE /AWS1/IAMPATHTYPE /AWS1/IAMPATHTYPE

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

iv_policyusagefilter TYPE /AWS1/IAMPOLICYUSAGETYPE /AWS1/IAMPOLICYUSAGETYPE

The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

iv_marker TYPE /AWS1/IAMMARKERTYPE /AWS1/IAMMARKERTYPE

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

iv_maxitems TYPE /AWS1/IAMMAXITEMSTYPE /AWS1/IAMMAXITEMSTYPE

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

RETURNING

oo_output TYPE REF TO /aws1/cl_iamlistentsforplyrsp /AWS1/CL_IAMLISTENTSFORPLYRSP

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->/aws1/if_iam~listentitiesforpolicy(
  iv_entityfilter = |string|
  iv_marker = |string|
  iv_maxitems = 123
  iv_pathprefix = |string|
  iv_policyarn = |string|
  iv_policyusagefilter = |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_policygroups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_groupnametype = lo_row_1->get_groupname( ).
      lv_idtype = lo_row_1->get_groupid( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_policyusers( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_usernametype = lo_row_3->get_username( ).
      lv_idtype = lo_row_3->get_userid( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_policyroles( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lv_rolenametype = lo_row_5->get_rolename( ).
      lv_idtype = lo_row_5->get_roleid( ).
    ENDIF.
  ENDLOOP.
  lv_booleantype = lo_result->get_istruncated( ).
  lv_responsemarkertype = lo_result->get_marker( ).
ENDIF.