GetPolicyCommand

Suggest an Edit

Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.

This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

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, GetPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, GetPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // GetPolicyRequest
  PolicyArn: "STRING_VALUE", // required
};
const command = new GetPolicyCommand(input);
const response = await client.send(command);
// { // GetPolicyResponse
//   Policy: { // Policy
//     PolicyName: "STRING_VALUE",
//     PolicyId: "STRING_VALUE",
//     Arn: "STRING_VALUE",
//     Path: "STRING_VALUE",
//     DefaultVersionId: "STRING_VALUE",
//     AttachmentCount: Number("int"),
//     PermissionsBoundaryUsageCount: Number("int"),
//     IsAttachable: true || false,
//     Description: "STRING_VALUE",
//     CreateDate: new Date("TIMESTAMP"),
//     UpdateDate: new Date("TIMESTAMP"),
//     Tags: [ // tagListType
//       { // Tag
//         Key: "STRING_VALUE", // required
//         Value: "STRING_VALUE", // required
//       },
//     ],
//   },
// };

GetPolicyCommand Input

See GetPolicyCommandInput for more details

Parameter
Type
Description
PolicyArn
Required
string | undefined

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs)  in the Amazon Web Services General Reference.

GetPolicyCommand Output

See GetPolicyCommandOutput for details

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

A structure containing details about the policy.

Throws

Name
Fault
Details
InvalidInputException
client

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

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.