DescribeConditionalForwarders - Amazon Directory Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Obtains information about the conditional forwarders for this account.

If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.

Request Syntax

{ "DirectoryId": "string", "RemoteDomainNames": [ "string" ] }

Request Parameters

The request accepts the following data in JSON format.


The directory ID for which to get the list of associated conditional forwarders.

Type: String

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

Required: Yes


The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.

Type: Array of strings

Length Constraints: Maximum length of 1024.

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

Required: No

Response Syntax

{ "ConditionalForwarders": [ { "DnsIpAddrs": [ "string" ], "RemoteDomainName": "string", "ReplicationScope": "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.


The list of conditional forwarders that have been created.

Type: Array of ConditionalForwarder objects


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 could not be found.

HTTP Status Code: 400


One or more parameters are not valid.

HTTP Status Code: 400


An exception has occurred in Amazon Directory Service.

HTTP Status Code: 500


The operation is not supported.

HTTP Status Code: 400


The following examples are formatted for legibility.

Example Request

This example illustrates one usage of DescribeConditionalForwarders.

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 79 X-Amz-Target: DirectoryService_20150416.DescribeConditionalForwarders X-Amz-Date: 20161214T020215Z 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=d8f7ff4237b393b4734bbf5d96713dff3deff651b4ab348f64bd776606147f9d { "DirectoryId": "d-926example", "RemoteDomainNames": [""] }

Example Response

This example illustrates one usage of DescribeConditionalForwarders.

HTTP/1.1 200 OK x-amzn-RequestId: 56d08425-c1a1-11e6-a132-e5016ac609f4 Content-Type: application/x-amz-json-1.1 Content-Length: 28 Date: Wed, 14 Dec 2016 02:02:18 GMT { "ConditionalForwarders": [ { "RemoteDomainName": "", "DnsIpAddrs": [ "" ], "ReplicationScope": "Domain" } ] }

See Also

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