:doc:`WorkSpaces <../../workspaces>` / Paginator / DescribeIpGroups

****************
DescribeIpGroups
****************



.. py:class:: WorkSpaces.Paginator.DescribeIpGroups

  ::

    
    paginator = client.get_paginator('describe_ip_groups')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`WorkSpaces.Client.describe_ip_groups`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeIpGroups>`_    


    **Request Syntax**
    ::

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

      The identifiers of one or more IP access control groups.

      

    
      - *(string) --* 

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

      
      ::

        {
            'Result': [
                {
                    'groupId': 'string',
                    'groupName': 'string',
                    'groupDesc': 'string',
                    'userRules': [
                        {
                            'ipRule': 'string',
                            'ruleDesc': 'string'
                        },
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Result** *(list) --* 

          Information about the IP access control groups.

          
          

          - *(dict) --* 

            Describes an IP access control group.

            
            

            - **groupId** *(string) --* 

              The identifier of the group.

              
            

            - **groupName** *(string) --* 

              The name of the group.

              
            

            - **groupDesc** *(string) --* 

              The description of the group.

              
            

            - **userRules** *(list) --* 

              The rules.

              
              

              - *(dict) --* 

                Describes a rule for an IP access control group.

                
                

                - **ipRule** *(string) --* 

                  The IP address range, in CIDR notation.

                  
                

                - **ruleDesc** *(string) --* 

                  The description.

                  
            
          
        
      
    