Class PutRolePermissionsBoundaryCommandProtected

Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.

You cannot set the boundary for a service-linked role.

Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.

Example

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

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

Param

PutRolePermissionsBoundaryCommandInput

Returns

PutRolePermissionsBoundaryCommandOutput

See

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

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.