:doc:`IAM <../../iam>` / Paginator / ListGroupsForUser

*****************
ListGroupsForUser
*****************



.. py:class:: IAM.Paginator.ListGroupsForUser

  ::

    
    paginator = client.get_paginator('list_groups_for_user')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`IAM.Client.list_groups_for_user`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/ListGroupsForUser>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          UserName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type UserName: string
    :param UserName: **[REQUIRED]** 

      The name of the user to list groups for.

       

      This parameter allows (through its `regex pattern <http://wikipedia.org/wiki/regex>`__) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Groups': [
                {
                    'Path': 'string',
                    'GroupName': 'string',
                    'GroupId': 'string',
                    'Arn': 'string',
                    'CreateDate': datetime(2015, 1, 1)
                },
            ],
            'IsTruncated': True|False,
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Contains the response to a successful `ListGroupsForUser <https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListGroupsForUser.html>`__ request.

        
        

        - **Groups** *(list) --* 

          A list of groups.

          
          

          - *(dict) --* 

            Contains information about an IAM group entity.

             

            This data type is used as a response element in the following operations:

             

            
            * `CreateGroup <https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateGroup.html>`__
             
            * `GetGroup <https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetGroup.html>`__
             
            * `ListGroups <https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListGroups.html>`__
            

            
            

            - **Path** *(string) --* 

              The path to the group. For more information about paths, see `IAM identifiers <https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html>`__ in the *IAM User Guide*.

              
            

            - **GroupName** *(string) --* 

              The friendly name that identifies the group.

              
            

            - **GroupId** *(string) --* 

              The stable and unique string identifying the group. For more information about IDs, see `IAM identifiers <https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html>`__ in the *IAM User Guide*.

              
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see `IAM identifiers <https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html>`__ in the *IAM User Guide*.

              
            

            - **CreateDate** *(datetime) --* 

              The date and time, in `ISO 8601 date-time format <http://www.iso.org/iso/iso8601>`__, when the group was created.

              
        
      
        

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

          
    