LISTGROUPS()`¶

About ListGroups¶

Lists the IAM groups that have the specified path prefix.

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

Method Signature¶

IMPORTING¶

Optional arguments:¶

`iv_pathprefix` `TYPE /AWS1/IAMPATHPREFIXTYPE` `/AWS1/IAMPATHPREFIXTYPE`¶

The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. 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_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_iamlistgroupsresponse` `/AWS1/CL_IAMLISTGROUPSRESPONSE`¶

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~listgroups(
  iv_marker = |string|
  iv_maxitems = 123
  iv_pathprefix = |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_groups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_pathtype = lo_row_1->get_path( ).
      lv_groupnametype = lo_row_1->get_groupname( ).
      lv_idtype = lo_row_1->get_groupid( ).
      lv_arntype = lo_row_1->get_arn( ).
      lv_datetype = lo_row_1->get_createdate( ).
    ENDIF.
  ENDLOOP.
  lv_booleantype = lo_result->get_istruncated( ).
  lv_responsemarkertype = lo_result->get_marker( ).
ENDIF.

To list the IAM groups for the current account¶

The following command lists the IAM groups in the current account:

DATA(lo_result) = lo_client->/aws1/if_iam~listgroups( ).

/AWS1/CL_IAM=>LISTGROUPS()¶