Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class ListGroupPoliciesCommandProtected

Lists the names of the inline policies that are embedded in the specified IAM group.

An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.

Example

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

import { IAMClient, ListGroupPoliciesCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, ListGroupPoliciesCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // ListGroupPoliciesRequest
GroupName: "STRING_VALUE", // required
Marker: "STRING_VALUE",
MaxItems: Number("int"),
};
const command = new ListGroupPoliciesCommand(input);
const response = await client.send(command);
// { // ListGroupPoliciesResponse
// PolicyNames: [ // policyNameListType // required
// "STRING_VALUE",
// ],
// IsTruncated: true || false,
// Marker: "STRING_VALUE",
// };

Param

ListGroupPoliciesCommandInput

Returns

ListGroupPoliciesCommandOutput

See

Throws

NoSuchEntityException (client fault)

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

Throws

ServiceFailureException (server fault)

The request processing has failed because of an unknown error, exception or failure.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.

Example

To list the in-line policies for an IAM group

// The following command lists the names of in-line policies that are embedded in the IAM group named Admins.
const input = {
"GroupName": "Admins"
};
const command = new ListGroupPoliciesCommand(input);
const response = await client.send(command);
/* response ==
{
"PolicyNames": [
"AdminRoot",
"KeyPolicy"
]
}
*/
// example id: 02de5095-2410-4d3a-ac1b-cc40234af68f

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods