IoT / Paginator / ListAttachedPolicies

ListAttachedPolicies¶

class IoT.Paginator.ListAttachedPolicies¶

paginator = client.get_paginator('list_attached_policies')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from IoT.Client.list_attached_policies().

Request Syntax

response_iterator = paginator.paginate(
    target='string',
    recursive=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

target (string) –
[REQUIRED]

The group or principal for which the policies will be listed. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
recursive (boolean) – When true, recursively list attached policies.
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',
            'policyArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- policies (list) –
  
  The policies.
  - (dict) –
    
    Describes an IoT policy.
    - policyName (string) –
      
      The policy name.
    - policyArn (string) –
      
      The policy ARN.
- NextToken (string) –
  
  A token to resume pagination.