IAM / Paginator / ListPolicies

ListPolicies#

class IAM.Paginator.ListPolicies#

paginator = client.get_paginator('list_policies')

paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Scope='All'|'AWS'|'Local',
    OnlyAttached=True|False,
    PathPrefix='string',
    PolicyUsageFilter='PermissionsPolicy'|'PermissionsBoundary',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

Scope (string) –
The scope to use for filtering the results.

To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

This parameter is optional. If it is not included, or if it is set to All, all policies are returned.
OnlyAttached (boolean) –
A flag to filter the results to only the attached policies.

When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.
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 policies. 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

{
    'Policies': [
        {
            'PolicyName': 'string',
            'PolicyId': 'string',
            'Arn': 'string',
            'Path': 'string',
            'DefaultVersionId': 'string',
            'AttachmentCount': 123,
            'PermissionsBoundaryUsageCount': 123,
            'IsAttachable': True|False,
            'Description': 'string',
            'CreateDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'IsTruncated': True|False,
    'NextToken': 'string'
}

Response Structure

(dict) –

Contains the response to a successful ListPolicies request.
- Policies (list) –
  
  A list of policies.
  - (dict) –
    
    Contains information about a managed policy.
    
    This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies operations.
    
    For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.
    - PolicyName (string) –
      
      The friendly name (not ARN) identifying the policy.
    - PolicyId (string) –
      
      The stable and unique string identifying the policy.
      
      For more information about IDs, see IAM identifiers in the IAM User Guide.
    - Arn (string) –
      
      The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
      
      For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
    - Path (string) –
      
      The path to the policy.
      
      For more information about paths, see IAM identifiers in the IAM User Guide.
    - DefaultVersionId (string) –
      
      The identifier for the version of the policy that is set as the default version.
    - AttachmentCount (integer) –
      
      The number of entities (users, groups, and roles) that the policy is attached to.
    - PermissionsBoundaryUsageCount (integer) –
      
      The number of entities (users and roles) for which the policy is used to set the permissions boundary.
      
      For more information about permissions boundaries, see `Permissions boundaries for IAM identities <https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html>`__in the IAM User Guide.
    - IsAttachable (boolean) –
      
      Specifies whether the policy can be attached to an IAM user, group, or role.
    - Description (string) –
      
      A friendly description of the policy.
      
      This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
    - CreateDate (datetime) –
      
      The date and time, in ISO 8601 date-time format, when the policy was created.
    - UpdateDate (datetime) –
      
      The date and time, in ISO 8601 date-time format, when the policy was last updated.
      
      When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
    - Tags (list) –
      
      A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
      - (dict) –
        
        A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
        
        Key (string) –
        
        The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.
        
        Value (string) –
        
        The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.
        
        Note
        
        Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
- 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.