Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeDomainControllers

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.

DirectoryId

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

Type: String

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

Required: Yes

DomainControllerIds

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

The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

NextToken

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.

DomainControllers

List of the DomainController objects that were retrieved.

Type: Array of DomainController objects

NextToken

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

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

EntityDoesNotExistException

The specified entity could not be found.

HTTP Status Code: 400

InvalidNextTokenException

The NextToken value is not valid.

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