- 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.
DeleteUserPolicyCommand
Deletes the specified inline policy that is embedded in the specified IAM user.
A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to 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, DeleteUserPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, DeleteUserPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // DeleteUserPolicyRequest
UserName: "STRING_VALUE", // required
PolicyName: "STRING_VALUE", // required
};
const command = new DeleteUserPolicyCommand(input);
const response = await client.send(command);
// {};
Example Usage
DeleteUserPolicyCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
PolicyName Required | string | undefined | The name identifying the policy document to delete. 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: _+=,.- |
UserName Required | string | undefined | The name (friendly name, not ARN) identifying the user that the policy is embedded in. 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: _+=,.- |
DeleteUserPolicyCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
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. |