DirectoryService / Client / update_number_of_domain_controllers

update_number_of_domain_controllers#

DirectoryService.Client.update_number_of_domain_controllers(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_number_of_domain_controllers(
    DirectoryId='string',
    DesiredNumber=123
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

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

  • DesiredNumber (integer) –

    [REQUIRED]

    The number of domain controllers desired in the directory.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • DirectoryService.Client.exceptions.EntityDoesNotExistException

  • DirectoryService.Client.exceptions.DirectoryUnavailableException

  • DirectoryService.Client.exceptions.DomainControllerLimitExceededException

  • DirectoryService.Client.exceptions.InvalidParameterException

  • DirectoryService.Client.exceptions.UnsupportedOperationException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException