Menu
AWS Directory Service
API Reference

UpdateNumberOfDomainControllers

Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.

Request Syntax

{
   "DesiredNumber": number,
   "DirectoryId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

DesiredNumber

The number of domain controllers desired in the directory.

Type: Integer

Valid Range: Minimum value of 2.

Required: Yes

DirectoryId

Identifier of the directory to which the domain controllers will be added or removed.

Type: String

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

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

HTTP Status Code: 400

DomainControllerLimitExceededException

The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.

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

See Also

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