:doc:`IAM <../../iam>` / Client / list_groups_for_user

********************
list_groups_for_user
********************



.. py:method:: IAM.Client.list_groups_for_user(**kwargs)

  

  Lists the IAM groups that the specified IAM user belongs to.

   

  You can paginate the results using the ``MaxItems`` and ``Marker`` parameters.

  

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


  **Request Syntax**
  ::

    response = client.list_groups_for_user(
        UserName='string',
        Marker='string',
        MaxItems=123
    )
    
  :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 Marker: string
  :param Marker: 

    Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the ``Marker`` element in the response that you received to indicate where the next call should start.

    

  
  :type MaxItems: integer
  :param MaxItems: 

    Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the ``IsTruncated`` response element is ``true``.

     

    If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the ``IsTruncated`` response element returns ``true``, and ``Marker`` contains a value to include in the subsequent call that tells the service where to continue from.

    

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

    
    ::

      {
          'Groups': [
              {
                  'Path': 'string',
                  'GroupName': 'string',
                  'GroupId': 'string',
                  'Arn': 'string',
                  'CreateDate': datetime(2015, 1, 1)
              },
          ],
          'IsTruncated': True|False,
          'Marker': '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.

        
      

      - **Marker** *(string) --* 

        When ``IsTruncated`` is ``true``, this element is present and contains the value to use for the ``Marker`` parameter in a subsequent pagination request.

        
  
  **Exceptions**
  
  *   :py:class:`IAM.Client.exceptions.NoSuchEntityException`

  
  *   :py:class:`IAM.Client.exceptions.ServiceFailureException`

  

  **Examples**

  The following command displays the groups that the IAM user named Bob belongs to.
  ::

    response = client.list_groups_for_user(
        UserName='Bob',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'Groups': [
            {
                'Arn': 'arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test',
                'CreateDate': datetime(2016, 11, 30, 14, 10, 1, 2, 335, 0),
                'GroupId': 'AGP2111111111EXAMPLE',
                'GroupName': 'Test',
                'Path': '/division_abc/subdivision_xyz/product_1234/engineering/',
            },
            {
                'Arn': 'arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers',
                'CreateDate': datetime(2016, 6, 12, 20, 14, 52, 6, 164, 0),
                'GroupId': 'AGPI222222222SEXAMPLE',
                'GroupName': 'Managers',
                'Path': '/division_abc/subdivision_xyz/product_1234/',
            },
        ],
        'ResponseMetadata': {
            '...': '...',
        },
    }

  