AWS Directory Service
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

Request Syntax

{ "DirectoryId": "string", "DnsIpAddrs": [ "string" ], "RemoteDomainName": "string" }

Request Parameters

The request accepts the following data in JSON format.


The directory ID of the AWS directory for which you are creating the conditional forwarder.

Type: String

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

Required: Yes


The IP addresses of the remote DNS server associated with RemoteDomainName.

Type: Array of strings

Pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

Required: Yes


The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

Type: String

Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+[.]?$

Required: Yes

Response Elements

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


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


A client exception has occurred.

HTTP Status Code: 400


The specified directory is unavailable or could not be found.

HTTP Status Code: 400


The specified entity already exists.

HTTP Status Code: 400


The specified entity could not be found.

HTTP Status Code: 400


One or more parameters are not valid.

HTTP Status Code: 400


An exception has occurred in AWS Directory Service.

HTTP Status Code: 500


The operation is not supported.

HTTP Status Code: 400


The following examples are formatted for legibility.

Example Request

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 105 X-Amz-Target: DirectoryService_20150416.CreateConditionalForwarder X-Amz-Date: 20161213T215543Z 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/20161213/us-west-2/ds/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=717e381f0258731fe0197c68d1f5d2a0e96825119c15a6e0dcfa2d07063c6af6 { "DirectoryId":"d-926example", "RemoteDomainName":"", "DnsIpAddrs":[ "" ] }

Example Response

HTTP/1.1 200 OK x-amzn-RequestId: 68e74443-c180-11e6-91f4-6dbff6648f8a Content-Type: application/x-amz-json-1.1 Content-Length: 2 Date: Tue, 13 Dec 2016 22:06:34 GMT { }

See Also

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