Menu
AWS Directory Service
API Reference

ListIpRoutes

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

Request Syntax

Copy
{ "DirectoryId": "string", "Limit": number, "NextToken": "string" }

Request Parameters

The request accepts the following data in JSON format.

DirectoryId

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

Type: String

Pattern: ^d-[0-9a-f]{10}$

Required: Yes

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.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

NextToken

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

Type: String

Required: No

Response Syntax

Copy
{ "IpRoutesInfo": [ { "AddedDateTime": number, "CidrIp": "string", "Description": "string", "DirectoryId": "string", "IpRouteStatusMsg": "string", "IpRouteStatusReason": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

IpRoutesInfo

A list of IpRoutes.

Type: Array of IpRouteInfo objects

NextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

ClientException

A client exception has occurred.

HTTP Status Code: 400

EntityDoesNotExistException

The specified entity could not be found.

HTTP Status Code: 400

InvalidNextTokenException

The NextToken value is not valid.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

HTTP Status Code: 500

Examples

The following examples are formatted for legibility.

Example Request

Copy
POST / HTTP/1.1 Host: ds.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 43 X-Amz-Target: DirectoryService_20150416.ListIpRoutes X-Amz-Date: 20161214T225328Z User-Agent: aws-cli/1.11.24 Python/2.7.9 Windows/7 botocore/1.4.81 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20161214/us-west-2/ds/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=4dcb72aae179937790f5b061ceb1c697ac434b27891014b609671e49e52be1dd { "DirectoryId":"d-926example", "Limit": 0 }

Example Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: 2214ceaa-c250-11e6-a7ca-f9a52a6a0390 Content-Type: application/x-amz-json-1.1 Content-Length: 155 Date: Wed, 14 Dec 2016 22:53:30 GMT { "IpRoutesInfo":[ { "AddedDateTime":1.48157763163E9, "CidrIp":"12.12.12.12/32", "Description":"example", "DirectoryId":"d-926example", "IpRouteStatusMsg":"Added" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: