ListPolicyVersionsCommand

Suggest an Edit

Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.

For more information about managed 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, ListPolicyVersionsCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, ListPolicyVersionsCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // ListPolicyVersionsRequest
  PolicyArn: "STRING_VALUE", // required
  Marker: "STRING_VALUE",
  MaxItems: Number("int"),
};
const command = new ListPolicyVersionsCommand(input);
const response = await client.send(command);
// { // ListPolicyVersionsResponse
//   Versions: [ // policyDocumentVersionListType
//     { // PolicyVersion
//       Document: "STRING_VALUE",
//       VersionId: "STRING_VALUE",
//       IsDefaultVersion: true || false,
//       CreateDate: new Date("TIMESTAMP"),
//     },
//   ],
//   IsTruncated: true || false,
//   Marker: "STRING_VALUE",
// };

ListPolicyVersionsCommand Input

See ListPolicyVersionsCommandInput for more details

Parameter
Type
Description
PolicyArn
Required
string | undefined

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

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

Marker
string | undefined

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

MaxItems
number | undefined

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

ListPolicyVersionsCommand Output

See ListPolicyVersionsCommandOutput for details

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

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

Marker
string | undefined

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Versions
PolicyVersion[] | undefined

A list of policy versions.

For more information about managed policy versions, see Versioning for managed policies  in the IAM User Guide.

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.