VerifiedPermissions / Paginator / ListPolicyStoreAliases

ListPolicyStoreAliases¶

class VerifiedPermissions.Paginator.ListPolicyStoreAliases¶

paginator = client.get_paginator('list_policy_store_aliases')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from VerifiedPermissions.Client.list_policy_store_aliases().

Request Syntax

response_iterator = paginator.paginate(
    filter={
        'policyStoreId': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

filter (dict) –
Specifies a filter to narrow the results. You can filter by policyStoreId to list only the policy store aliases associated with a specific policy store.
- policyStoreId (string) –
  
  The ID of the policy store to filter by. Only policy store aliases associated with this policy store are returned.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'policyStoreAliases': [
        {
            'aliasName': 'string',
            'policyStoreId': 'string',
            'aliasArn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'state': 'Active'|'PendingDeletion'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- policyStoreAliases (list) –
  
  The list of policy store aliases in the account.
  - (dict) –
    
    Contains information about a policy store alias.
    
    This data type is used as a response parameter for the ListPolicyStoreAliases operation.
    - aliasName (string) –
      
      The name of the policy store alias.
    - policyStoreId (string) –
      
      The ID of the policy store associated with the alias.
    - aliasArn (string) –
      
      The Amazon Resource Name (ARN) of the policy store alias.
    - createdAt (datetime) –
      
      The date and time the policy store alias was created.
    - state (string) –
      
      The state of the policy store alias. Policy Store Aliases in the Active state can be used normally. When a policy store alias is deleted, it enters the PendingDeletion state. Policy Store Aliases in the PendingDeletion state cannot be used, and creating a policy store alias with the same alias name will fail.
- NextToken (string) –
  
  A token to resume pagination.