UpdateConditionalForwarder - AWS Directory Service

UpdateConditionalForwarder

Updates a conditional forwarder that has been set up for your AWS directory.

Request Syntax

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

Request Parameters

The request accepts the following data in JSON format.

DirectoryId

The directory ID of the AWS directory for which to update the conditional forwarder.

Type: String

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

Required: Yes

DnsIpAddrs

The updated IP addresses of the remote DNS server associated with the conditional forwarder.

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

RemoteDomainName

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

Type: String

Length Constraints: Maximum length of 1024.

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.

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

DirectoryUnavailableException

The specified directory is unavailable.

HTTP Status Code: 400

EntityDoesNotExistException

The specified entity could not be found.

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

UnsupportedOperationException

The operation is not supported.

HTTP Status Code: 400

Examples

The following examples are formatted for legibility.

Example Request

This example illustrates one usage of UpdateConditionalForwarder.

POST / HTTP/1.1 Host: ds.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 107 X-Amz-Target: DirectoryService_20150416.UpdateConditionalForwarder X-Amz-Date: 20161215T183823Z 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/20161215/us-west-2/ds/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=84648cead858ef1efd7db75ce248aa3e22a78139b109eec6122dc3c495b71085 { "DirectoryId":"d-926example", "RemoteDomainName":"sales.example.com", "DnsIpAddrs": ["172.168.101.11"] }

Example Response

This example illustrates one usage of UpdateConditionalForwarder.

HTTP/1.1 200 OK x-amzn-RequestId: aa015a05-c2f5-11e6-b3d3-bf8f15b8b2ee Content-Type: application/x-amz-json-1.1 Content-Length: 2 Date: Thu, 15 Dec 2016 18:38:27 GMT { }

See Also

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