Class GetUserPolicyCommandProtected

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

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
// };

Param

GetUserPolicyCommandInput

Returns

GetUserPolicyCommandOutput

See

• GetUserPolicyCommandInput for command's input shape.
• GetUserPolicyCommandOutput for command's response shape.
• config for IAMClient's config shape.

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

ServiceFailureException (server fault)

The request processing has failed because of an unknown error, exception or failure.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.