# DescribeDomainControllers
<a name="API_DescribeDomainControllers"></a>

Provides information about any domain controllers in your directory.

## Request Syntax
<a name="API_DescribeDomainControllers_RequestSyntax"></a>

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

## Request Parameters
<a name="API_DescribeDomainControllers_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeDomainControllers_RequestSyntax) **   <a name="DirectoryService-DescribeDomainControllers-request-DirectoryId"></a>
Identifier of the directory for which to retrieve the domain controller information.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [DomainControllerIds](#API_DescribeDomainControllers_RequestSyntax) **   <a name="DirectoryService-DescribeDomainControllers-request-DomainControllerIds"></a>
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

 ** [Limit](#API_DescribeDomainControllers_RequestSyntax) **   <a name="DirectoryService-DescribeDomainControllers-request-Limit"></a>
The maximum number of items to return.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [NextToken](#API_DescribeDomainControllers_RequestSyntax) **   <a name="DirectoryService-DescribeDomainControllers-request-NextToken"></a>
The *DescribeDomainControllers.NextToken* value from a previous call to [DescribeDomainControllers](#API_DescribeDomainControllers). Pass null if this is the first call.   
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeDomainControllers_ResponseSyntax"></a>

```
{
   "DomainControllers": [ 
      { 
         "AvailabilityZone": "string",
         "DirectoryId": "string",
         "DnsIpAddr": "string",
         "DnsIpv6Addr": "string",
         "DomainControllerId": "string",
         "LaunchTime": number,
         "Status": "string",
         "StatusLastUpdatedDateTime": number,
         "StatusReason": "string",
         "SubnetId": "string",
         "VpcId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeDomainControllers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DomainControllers](#API_DescribeDomainControllers_ResponseSyntax) **   <a name="DirectoryService-DescribeDomainControllers-response-DomainControllers"></a>
List of the [DomainController](API_DomainController.md) objects that were retrieved.  
Type: Array of [DomainController](API_DomainController.md) objects

 ** [NextToken](#API_DescribeDomainControllers_ResponseSyntax) **   <a name="DirectoryService-DescribeDomainControllers-response-NextToken"></a>
If not null, more results are available. Pass this value for the `NextToken` parameter in a subsequent call to [DescribeDomainControllers](#API_DescribeDomainControllers) retrieve the next set of items.  
Type: String

## Errors
<a name="API_DescribeDomainControllers_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_DescribeDomainControllers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeDomainControllers)