Skip to content

Describe Domain Controllers

directoryservice_describe_domain_controllers R Documentation

Provides information about any domain controllers in your directory

Description

Provides information about any domain controllers in your directory.

Usage

directoryservice_describe_domain_controllers(DirectoryId,
  DomainControllerIds, NextToken, Limit)

Arguments

DirectoryId

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

DomainControllerIds

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

NextToken

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

Limit

The maximum number of items to return.

Value

A list with the following syntax:

list(
  DomainControllers = list(
    list(
      DirectoryId = "string",
      DomainControllerId = "string",
      DnsIpAddr = "string",
      VpcId = "string",
      SubnetId = "string",
      AvailabilityZone = "string",
      Status = "Creating"|"Active"|"Impaired"|"Restoring"|"Deleting"|"Deleted"|"Failed",
      StatusReason = "string",
      LaunchTime = as.POSIXct(
        "2015-01-01"
      ),
      StatusLastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_domain_controllers(
  DirectoryId = "string",
  DomainControllerIds = list(
    "string"
  ),
  NextToken = "string",
  Limit = 123
)