VerifiedPermissions / Client / list_policy_templates

list_policy_templates#

VerifiedPermissions.Client.list_policy_templates(**kwargs)#

Returns a paginated list of all policy templates in the specified policy store.

See also: AWS API Documentation

Request Syntax

response = client.list_policy_templates(
    policyStoreId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • policyStoreId (string) –

    [REQUIRED]

    Specifies the ID of the policy store that contains the policy templates you want to list.

  • nextToken (string) – Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s NextToken response to request the next page of results.

  • maxResults (integer) –

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    If you do not specify this parameter, the operation defaults to 10 policy templates per response. You can specify a maximum of 50 policy templates per response.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'policyTemplates': [
        {
            'policyStoreId': 'string',
            'policyTemplateId': 'string',
            'description': 'string',
            'createdDate': datetime(2015, 1, 1),
            'lastUpdatedDate': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

    • policyTemplates (list) –

      The list of the policy templates in the specified policy store.

      • (dict) –

        Contains details about a policy template

        This data type is used as a response parameter for the ListPolicyTemplates operation.

        • policyStoreId (string) –

          The unique identifier of the policy store that contains the template.

        • policyTemplateId (string) –

          The unique identifier of the policy template.

        • description (string) –

          The description attached to the policy template.

        • createdDate (datetime) –

          The date and time that the policy template was created.

        • lastUpdatedDate (datetime) –

          The date and time that the policy template was most recently updated.

Exceptions