GetUserPolicyCommand

Suggest an Edit

Retrieves the specified inline policy document that is embedded in the specified IAM user.

Policies returned by this operation are URL-encoded compliant with RFC 3986 . You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion to retrieve the policy document.

For more 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, GetUserPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, GetUserPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // GetUserPolicyRequest
  UserName: "STRING_VALUE", // required
  PolicyName: "STRING_VALUE", // required
};
const command = new GetUserPolicyCommand(input);
const response = await client.send(command);
// { // GetUserPolicyResponse
//   UserName: "STRING_VALUE", // required
//   PolicyName: "STRING_VALUE", // required
//   PolicyDocument: "STRING_VALUE", // required
// };

GetUserPolicyCommand Input

See GetUserPolicyCommandInput for more details

Parameter
Type
Description
PolicyName
Required
string | undefined

The name of the policy document to get.

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 of the user who the policy is associated with.

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: _+=,.-

GetUserPolicyCommand Output

See GetUserPolicyCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
PolicyDocument
Required
string | undefined

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

PolicyName
Required
string | undefined

The name of the policy.

UserName
Required
string | undefined

The user the policy is associated with.

Throws

Name
Fault
Details
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.