DirectoryService / Paginator / ListIpRoutes


class DirectoryService.Paginator.ListIpRoutes#
paginator = client.get_paginator('list_ip_routes')

Creates an iterator that will paginate through responses from DirectoryService.Client.list_ip_routes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • DirectoryId (string) –


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

  • PaginationConfig (dict) –

    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.

Return type:



Response Syntax

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

        • 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.