v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1434249272.1 KB

Retrieves details about a policy store.

post/#X-Amz-Target=VerifiedPermissions.GetPolicyStore

Headers

X-Amz-Target'VerifiedPermissions.GetPolicyStore' required

Request body

policyStoreIdstring required
<p>Specifies the policy store 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>
tagsboolean
<p>Specifies whether to return the tags that are attached to the policy store. If this parameter is included in the API call, the tags are returned, otherwise they are not returned.</p> <note> <p>If this parameter is included in the API call but there are no tags attached to the policy store, the <code>tags</code> response parameter is omitted from the response.</p> </note>

Response

Success

policyStoreIdstring required

The ID of the policy store;

arnstring required

The Amazon Resource Name (ARN) of the policy store.

createdDatestring date-time required

The date and time that the policy store was originally created.

lastUpdatedDatestring date-time required

The date and time that the policy store was last updated.

descriptionstring password

Descriptive text that you can provide to help with identification of the current policy store.

deletionProtection'ENABLED' | 'DISABLED'
<p>Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.</p> <p>The default state is <code>DISABLED</code>.</p>
cedarVersion'CEDAR_2' | 'CEDAR_4'

The version of the Cedar language used with policies, policy templates, and schemas in this policy store. For more information, see <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/cedar4-faq.html">Amazon Verified Permissions upgrade to Cedar v4 FAQ</a>.

tagsobject

The list of tags associated with the policy store.