VerifiedPermissions / Client / list_policy_store_aliases

list_policy_store_aliases¶

VerifiedPermissions.Client.list_policy_store_aliases(**kwargs)¶

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

Request Syntax

response = client.list_policy_store_aliases(
    nextToken='string',
    maxResults=123,
    filter={
        'policyStoreId': 'string'
    }
)

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 5 policy store aliases per response. You can specify a maximum of 50 policy store aliases per response.
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.

Return type:

dict

Returns:

Response Syntax

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

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.
- 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.

Exceptions

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