DirectoryService / Client / describe_conditional_forwarders

describe_conditional_forwarders#

DirectoryService.Client.describe_conditional_forwarders(**kwargs)#

Obtains information about the conditional forwarders for this account.

If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.

See also: AWS API Documentation

Request Syntax

response = client.describe_conditional_forwarders(
    DirectoryId='string',
    RemoteDomainNames=[
        'string',
    ]
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    The directory ID for which to get the list of associated conditional forwarders.

  • RemoteDomainNames (list) –

    The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ConditionalForwarders': [
        {
            'RemoteDomainName': 'string',
            'DnsIpAddrs': [
                'string',
            ],
            'ReplicationScope': 'Domain'
        },
    ]
}

Response Structure

  • (dict) –

    The result of a DescribeConditionalForwarder request.

    • ConditionalForwarders (list) –

      The list of conditional forwarders that have been created.

      • (dict) –

        Points to a remote domain with which you are setting up a trust relationship. Conditional forwarders are required in order to set up a trust relationship with another domain.

        • RemoteDomainName (string) –

          The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.

        • DnsIpAddrs (list) –

          The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to.

          • (string) –

        • ReplicationScope (string) –

          The replication scope of the conditional forwarder. The only allowed value is Domain , which will replicate the conditional forwarder to all of the domain controllers for your Amazon Web Services directory.

Exceptions

  • DirectoryService.Client.exceptions.EntityDoesNotExistException

  • DirectoryService.Client.exceptions.DirectoryUnavailableException

  • DirectoryService.Client.exceptions.InvalidParameterException

  • DirectoryService.Client.exceptions.UnsupportedOperationException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException