IAM / Paginator / ListEntitiesForPolicy

ListEntitiesForPolicy#

class IAM.Paginator.ListEntitiesForPolicy#

paginator = client.get_paginator('list_entities_for_policy')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from IAM.Client.list_entities_for_policy().

Request Syntax

response_iterator = paginator.paginate(
    PolicyArn='string',
    EntityFilter='User'|'Role'|'Group'|'LocalManagedPolicy'|'AWSManagedPolicy',
    PathPrefix='string',
    PolicyUsageFilter='PermissionsPolicy'|'PermissionsBoundary',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PolicyArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
EntityFilter (string) –
The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.
PathPrefix (string) –
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \u0021) through the DEL character ( \u007F), including most punctuation characters, digits, and upper and lowercased letters.
PolicyUsageFilter (string) –
The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies 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

{
    'PolicyGroups': [
        {
            'GroupName': 'string',
            'GroupId': 'string'
        },
    ],
    'PolicyUsers': [
        {
            'UserName': 'string',
            'UserId': 'string'
        },
    ],
    'PolicyRoles': [
        {
            'RoleName': 'string',
            'RoleId': 'string'
        },
    ],
    'IsTruncated': True|False,
    'NextToken': 'string'
}

Response Structure

(dict) –

Contains the response to a successful ListEntitiesForPolicy request.
- PolicyGroups (list) –
  
  A list of IAM groups that the policy is attached to.
  - (dict) –
    
    Contains information about a group that a managed policy is attached to.
    
    This data type is used as a response element in the ListEntitiesForPolicy operation.
    
    For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.
    - GroupName (string) –
      
      The name (friendly name, not ARN) identifying the group.
    - GroupId (string) –
      
      The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.
- PolicyUsers (list) –
  
  A list of IAM users that the policy is attached to.
  - (dict) –
    
    Contains information about a user that a managed policy is attached to.
    
    This data type is used as a response element in the ListEntitiesForPolicy operation.
    
    For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.
    - UserName (string) –
      
      The name (friendly name, not ARN) identifying the user.
    - UserId (string) –
      
      The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.
- PolicyRoles (list) –
  
  A list of IAM roles that the policy is attached to.
  - (dict) –
    
    Contains information about a role that a managed policy is attached to.
    
    This data type is used as a response element in the ListEntitiesForPolicy operation.
    
    For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.
    - RoleName (string) –
      
      The name (friendly name, not ARN) identifying the role.
    - RoleId (string) –
      
      The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.
- IsTruncated (boolean) –
  
  A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
- NextToken (string) –
  
  A token to resume pagination.