DirectoryService / Client / list_ip_routes

list_ip_routes#

DirectoryService.Client.list_ip_routes(**kwargs)#

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

Request Syntax

response = client.list_ip_routes(
    DirectoryId='string',
    NextToken='string',
    Limit=123
)

Parameters:

DirectoryId (string) –
[REQUIRED]

Identifier (ID) of the directory for which you want to retrieve the IP addresses.
NextToken (string) – The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.
Limit (integer) – Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Return type:

dict

Returns:

Response Syntax

{
    'IpRoutesInfo': [
        {
            'DirectoryId': 'string',
            'CidrIp': '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.
    - 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

DirectoryService.Client.exceptions.EntityDoesNotExistException
DirectoryService.Client.exceptions.InvalidNextTokenException
DirectoryService.Client.exceptions.InvalidParameterException
DirectoryService.Client.exceptions.ClientException
DirectoryService.Client.exceptions.ServiceException