Retrieves information about the specified policy.
post/#X-Amz-Target=VerifiedPermissions.GetPolicy
Headers
X-Amz-Target'VerifiedPermissions.GetPolicy' required
Request body
policyStoreIdstring required
<p>Specifies the ID of the policy store that contains the policy that you want information about.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
policyIdstring required
<p>Specifies the ID of the policy you want information about.</p> <p>You can use the policy name in place of the policy ID. When using a name, prefix it with <code>name/</code>. For example:</p> <ul> <li> <p>ID: <code>SPEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Name: <code>name/example-policy</code> </p> </li> </ul>
Response
Success
policyStoreIdstring required
The ID of the policy store that contains the policy that you want information about.
policyIdstring required
The unique ID of the policy that you want information about.
policyType'STATIC' | 'TEMPLATE_LINKED' required
The type of the policy.
createdDatestring date-time required
The date and time that the policy was originally created.
lastUpdatedDatestring date-time required
The date and time that the policy was last updated.
effect'Permit' | 'Forbid'
The effect of the decision that a policy returns to an authorization request. For example, <code>"effect": "Permit"</code>.
namestring
The name of the policy, if one was assigned when the policy was created or last updated.