- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DetachUserPolicyCommand
Removes the specified managed policy from the specified user.
A user can also have inline policies embedded with it. To delete an inline policy, use DeleteUserPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IAMClient, DetachUserPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, DetachUserPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // DetachUserPolicyRequest
UserName: "STRING_VALUE", // required
PolicyArn: "STRING_VALUE", // required
};
const command = new DetachUserPolicyCommand(input);
const response = await client.send(command);
// {};
DetachUserPolicyCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
PolicyArn Required | string | undefined | The Amazon Resource Name (ARN) of the IAM policy you want to detach. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. |
UserName Required | string | undefined | The name (friendly name, not ARN) of the IAM user to detach the policy from. This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.- |
DetachUserPolicyCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InvalidInputException | client | The request was rejected because an invalid or out-of-range value was supplied for an input parameter. |
LimitExceededException | client | 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. |
NoSuchEntityException | client | The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource. |
ServiceFailureException | server | The request processing has failed because of an unknown error, exception or failure. |
IAMServiceException | Base exception class for all service exceptions from IAM service. |