VerifiedPermissions / Client / get_policy_template

get_policy_template¶

VerifiedPermissions.Client.get_policy_template(**kwargs)¶

Retrieve the details for the specified policy template in the specified policy store.

Request Syntax

response = client.get_policy_template(
    policyStoreId='string',
    policyTemplateId='string'
)

Parameters:

policyStoreId (string) –
[REQUIRED]

Specifies the ID of the policy store that contains the policy template that you want information about.

To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:
- ID: PSEXAMPLEabcdefg111111
- Alias name: policy-store-alias/example-policy-store
To view aliases, use ListPolicyStoreAliases.
policyTemplateId (string) –
[REQUIRED]

Specifies the ID of the policy template that you want information about.

You can use the policy template name in place of the policy template ID. When using a name, prefix it with name/. For example:
- ID: PTEXAMPLEabcdefg111111
- Name: name/example-policy-template

Return type:

dict

Returns:

Response Syntax

{
    'policyStoreId': 'string',
    'policyTemplateId': 'string',
    'description': 'string',
    'statement': 'string',
    'createdDate': datetime(2015, 1, 1),
    'lastUpdatedDate': datetime(2015, 1, 1),
    'name': 'string'
}

Response Structure

(dict) –
- policyStoreId (string) –
  
  The ID of the policy store that contains the policy template.
- policyTemplateId (string) –
  
  The ID of the policy template.
- description (string) –
  
  The description of the policy template.
- statement (string) –
  
  The content of the body of the policy template written in the Cedar policy language.
- createdDate (datetime) –
  
  The date and time that the policy template was originally created.
- lastUpdatedDate (datetime) –
  
  The date and time that the policy template was most recently updated.
- name (string) –
  
  The name of the policy template, if one was assigned when the policy template was created or last updated.

Exceptions

VerifiedPermissions.Client.exceptions.ValidationException
VerifiedPermissions.Client.exceptions.AccessDeniedException
VerifiedPermissions.Client.exceptions.ResourceNotFoundException
VerifiedPermissions.Client.exceptions.ThrottlingException
VerifiedPermissions.Client.exceptions.InternalServerException