describe_domain_controllers

DirectoryService.Client.describe_domain_controllers(**kwargs)

Provides information about any domain controllers in your directory.

See also: AWS API Documentation

Request Syntax

response = client.describe_domain_controllers(
    DirectoryId='string',
    DomainControllerIds=[
        'string',
    ],
    NextToken='string',
    Limit=123
)

Parameters

• DirectoryId (string) --

  [REQUIRED]

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

• DomainControllerIds (list) --

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

  • (string) --
• NextToken (string) -- The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.
• Limit (integer) -- The maximum number of items to return.

Return type

dict

Returns

Response Syntax

{
    'DomainControllers': [
        {
            'DirectoryId': 'string',
            'DomainControllerId': 'string',
            'DnsIpAddr': 'string',
            'VpcId': 'string',
            'SubnetId': 'string',
            'AvailabilityZone': 'string',
            'Status': 'Creating'|'Active'|'Impaired'|'Restoring'|'Deleting'|'Deleted'|'Failed',
            'StatusReason': 'string',
            'LaunchTime': datetime(2015, 1, 1),
            'StatusLastUpdatedDateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • DomainControllers (list) --

    List of the DomainController objects that were retrieved.

    • (dict) --

      Contains information about the domain controllers for a specified directory.

      • DirectoryId (string) --

        Identifier of the directory where the domain controller resides.

      • DomainControllerId (string) --

        Identifies a specific domain controller in the directory.

      • DnsIpAddr (string) --

        The IP address of the domain controller.

      • VpcId (string) --

        The identifier of the VPC that contains the domain controller.

      • SubnetId (string) --

        Identifier of the subnet in the VPC that contains the domain controller.

      • AvailabilityZone (string) --

        The Availability Zone where the domain controller is located.

      • Status (string) --

        The status of the domain controller.

      • StatusReason (string) --

        A description of the domain controller state.

      • LaunchTime (datetime) --

        Specifies when the domain controller was created.

      • StatusLastUpdatedDateTime (datetime) --

        The date and time that the status was last updated.

  • NextToken (string) --

    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.

Exceptions

• DirectoryService.Client.exceptions.EntityDoesNotExistException
• DirectoryService.Client.exceptions.InvalidNextTokenException
• DirectoryService.Client.exceptions.InvalidParameterException
• DirectoryService.Client.exceptions.ClientException
• DirectoryService.Client.exceptions.ServiceException
• DirectoryService.Client.exceptions.UnsupportedOperationException