:doc:`DirectoryService <../../ds>` / Client / list_ip_routes

**************
list_ip_routes
**************



.. py:method:: DirectoryService.Client.list_ip_routes(**kwargs)

  

  Lists the address blocks that you have added to a directory.

  

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


  **Request Syntax**
  ::

    response = client.list_ip_routes(
        DirectoryId='string',
        NextToken='string',
        Limit=123
    )
    
  :type DirectoryId: string
  :param DirectoryId: **[REQUIRED]** 

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

    

  
  :type NextToken: string
  :param NextToken: 

    The *ListIpRoutes.NextToken* value from a previous call to  ListIpRoutes. Pass null if this is the first call.

    

  
  :type Limit: integer
  :param Limit: 

    Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

    

  
  
  :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'
              },
          ],
          'NextToken': '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.

            
      
    
      

      - **NextToken** *(string) --* 

        If not null, more results are available. Pass this value for the *NextToken* parameter in a subsequent call to  ListIpRoutes to retrieve the next set of items.

        
  
  **Exceptions**
  
  *   :py:class:`DirectoryService.Client.exceptions.EntityDoesNotExistException`

  
  *   :py:class:`DirectoryService.Client.exceptions.InvalidNextTokenException`

  
  *   :py:class:`DirectoryService.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`DirectoryService.Client.exceptions.ClientException`

  
  *   :py:class:`DirectoryService.Client.exceptions.ServiceException`

  