Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class GetGroupCommandProtected

Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.

Example

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

import { IAMClient, GetGroupCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, GetGroupCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // GetGroupRequest
GroupName: "STRING_VALUE", // required
Marker: "STRING_VALUE",
MaxItems: Number("int"),
};
const command = new GetGroupCommand(input);
const response = await client.send(command);
// { // GetGroupResponse
// Group: { // Group
// Path: "STRING_VALUE", // required
// GroupName: "STRING_VALUE", // required
// GroupId: "STRING_VALUE", // required
// Arn: "STRING_VALUE", // required
// CreateDate: new Date("TIMESTAMP"), // required
// },
// Users: [ // userListType // required
// { // User
// Path: "STRING_VALUE", // required
// UserName: "STRING_VALUE", // required
// UserId: "STRING_VALUE", // required
// Arn: "STRING_VALUE", // required
// CreateDate: new Date("TIMESTAMP"), // required
// PasswordLastUsed: new Date("TIMESTAMP"),
// PermissionsBoundary: { // AttachedPermissionsBoundary
// PermissionsBoundaryType: "PermissionsBoundaryPolicy",
// PermissionsBoundaryArn: "STRING_VALUE",
// },
// Tags: [ // tagListType
// { // Tag
// Key: "STRING_VALUE", // required
// Value: "STRING_VALUE", // required
// },
// ],
// },
// ],
// IsTruncated: true || false,
// Marker: "STRING_VALUE",
// };

Param

GetGroupCommandInput

Returns

GetGroupCommandOutput

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.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods