:doc:`DirectoryService <../../ds>` / Paginator / ListIpRoutes

************
ListIpRoutes
************



.. py:class:: DirectoryService.Paginator.ListIpRoutes

  ::

    
    paginator = client.get_paginator('list_ip_routes')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DirectoryService.Client.list_ip_routes`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ListIpRoutes>`_    


    **Request Syntax**
    ::

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

      Identifier (ID) of the directory for which you want to retrieve the IP addresses.

      

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

      
      ::

        {
            'IpRoutesInfo': [
                {
                    'DirectoryId': 'string',
                    'CidrIp': 'string',
                    'CidrIpv6': 'string',
                    'IpRouteStatusMsg': 'Adding'|'Added'|'Removing'|'Removed'|'AddFailed'|'RemoveFailed',
                    'AddedDateTime': datetime(2015, 1, 1),
                    'IpRouteStatusReason': 'string',
                    'Description': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **IpRoutesInfo** *(list) --* 

          A list of  IpRoutes.

          
          

          - *(dict) --* 

            Information about one or more IP address blocks.

            
            

            - **DirectoryId** *(string) --* 

              Identifier (ID) of the directory associated with the IP addresses.

              
            

            - **CidrIp** *(string) --* 

              IP address block in the  IpRoute.

              
            

            - **CidrIpv6** *(string) --* 

              IPv6 address block in the  IpRoute.

              
            

            - **IpRouteStatusMsg** *(string) --* 

              The status of the IP address block.

              
            

            - **AddedDateTime** *(datetime) --* 

              The date and time the address block was added to the directory.

              
            

            - **IpRouteStatusReason** *(string) --* 

              The reason for the IpRouteStatusMsg.

              
            

            - **Description** *(string) --* 

              Description of the  IpRouteInfo.

              
        
      
    