DescribeDomainControllers - 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).


Provides information about any domain controllers in your directory.

Request Syntax

{ "DirectoryId": "string", "DomainControllerIds": [ "string" ], "Limit": number, "NextToken": "string" }

Request Parameters

The request accepts the following data in JSON format.


Identifier of the directory for which to retrieve the domain controller information.

Type: String

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

Required: Yes


A list of identifiers for the domain controllers whose information will be provided.

Type: Array of strings

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

Required: No


The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 0.

Required: No


The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.

Type: String

Required: No

Response Syntax

{ "DomainControllers": [ { "AvailabilityZone": "string", "DirectoryId": "string", "DnsIpAddr": "string", "DomainControllerId": "string", "LaunchTime": number, "Status": "string", "StatusLastUpdatedDateTime": number, "StatusReason": "string", "SubnetId": "string", "VpcId": "string" } ], "NextToken": "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.


List of the DomainController objects that were retrieved.

Type: Array of DomainController objects


If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items.

Type: String


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

HTTP Status Code: 400


The NextToken value is not valid.

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

See Also

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