Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

ListGroupsCommand

Lists the IAM groups that have the specified path prefix.

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IAMClient, ListGroupsCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, ListGroupsCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // ListGroupsRequest
  PathPrefix: "STRING_VALUE",
  Marker: "STRING_VALUE",
  MaxItems: Number("int"),
};
const command = new ListGroupsCommand(input);
const response = await client.send(command);
// { // ListGroupsResponse
//   Groups: [ // groupListType // required
//     { // Group
//       Path: "STRING_VALUE", // required
//       GroupName: "STRING_VALUE", // required
//       GroupId: "STRING_VALUE", // required
//       Arn: "STRING_VALUE", // required
//       CreateDate: new Date("TIMESTAMP"), // required
//     },
//   ],
//   IsTruncated: true || false,
//   Marker: "STRING_VALUE",
// };

Example Usage

There was an error loading the code editor. Retry

ListGroupsCommand Input

See ListGroupsCommandInput for more details

Parameter	Type	Description
`Marker`	`string \| undefined`	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.
`MaxItems`	`number \| undefined`	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.
`PathPrefix`	`string \| undefined`	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.

ListGroupsCommand Output

See ListGroupsCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`Groups` Required	`Group[] \| undefined`	A list of groups.
`IsTruncated`	`boolean \| undefined`	A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the `Marker` request parameter to retrieve more items. Note that IAM might return fewer than the `MaxItems` number of results even when there are more results available. We recommend that you check `IsTruncated` after every call to ensure that you receive all your results.
`Marker`	`string \| undefined`	When `IsTruncated` is `true`, this element is present and contains the value to use for the `Marker` parameter in a subsequent pagination request.

Throws

Name	Fault	Details
ServiceFailureException	server	The request processing has failed because of an unknown error, exception or failure.
IAMServiceException		Base exception class for all service exceptions from IAM service.

Getting Started