Class AttachGroupPolicyCommandProtected

Attaches the specified managed policy to the specified IAM group.

You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy .

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

Example

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

import { IAMClient, AttachGroupPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, AttachGroupPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // AttachGroupPolicyRequest
  GroupName: "STRING_VALUE", // required
  PolicyArn: "STRING_VALUE", // required
};
const command = new AttachGroupPolicyCommand(input);
const response = await client.send(command);
// {};

Param

AttachGroupPolicyCommandInput

Returns

AttachGroupPolicyCommandOutput

See

• AttachGroupPolicyCommandInput for command's input shape.
• AttachGroupPolicyCommandOutput for command's response shape.
• config for IAMClient's config shape.

Throws

InvalidInputException (client fault)

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

Throws

LimitExceededException (client fault)

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

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

PolicyNotAttachableException (client fault)

The request failed because Amazon Web Services service role policies can only be attached to the service-linked role for that service.

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 attach a managed policy to an IAM group

// The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM group named Finance.
const input = {
  "GroupName": "Finance",
  "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess"
};
const command = new AttachGroupPolicyCommand(input);
await client.send(command);
// example id: 87551489-86f0-45db-9889-759936778f2b