VerifiedPermissions / Client / list_policy_stores

list_policy_stores#

VerifiedPermissions.Client.list_policy_stores(**kwargs)#

Returns a paginated list of all policy stores in the calling Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

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

  • 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 stores per response. You can specify a maximum of 50 policy stores per response.

Return type:

dict

Returns:

Response Syntax

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

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.

    • policyStores (list) –

      The list of policy stores in the account.

      • (dict) –

        Contains information about a policy store.

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

        • policyStoreId (string) –

          The unique identifier of the policy store.

        • arn (string) –

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

        • createdDate (datetime) –

          The date and time the policy was created.

        • lastUpdatedDate (datetime) –

          The date and time the policy store was most recently updated.

        • description (string) –

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

Exceptions