Class AttachRolePolicyCommandProtected

Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.

You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole . You can update a role's trust policy using UpdateAssumerolePolicy .

Use this operation to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy . For more information about policies, see Managed policies and inline policies in the IAM User Guide.

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

Example

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

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

Param

AttachRolePolicyCommandInput

Returns

AttachRolePolicyCommandOutput

See

• AttachRolePolicyCommandInput for command's input shape.
• AttachRolePolicyCommandOutput 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

UnmodifiableEntityException (client fault)

The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.

Example

To attach a managed policy to an IAM role

// The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM role named ReadOnlyRole.
const input = {
  "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess",
  "RoleName": "ReadOnlyRole"
};
const command = new AttachRolePolicyCommand(input);
await client.send(command);
// example id: 3e1b8c7c-99c8-4fc4-a20c-131fe3f22c7e