AWS Directory Service

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.

Request Syntax

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

type DirectoryId:

string

param DirectoryId:

[REQUIRED]

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

type RemoteDomainNames:

list

param RemoteDomainNames:

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) --

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • 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 AWS directory.

Deletes a conditional forwarder that has been set up for your AWS directory.

Request Syntax

client.delete_conditional_forwarder(
    DirectoryId='string',
    RemoteDomainName='string'
)

type DirectoryId:

string

param DirectoryId:

[REQUIRED]

The directory ID for which you are deleting the conditional forwarder.

type RemoteDomainName:

string

param RemoteDomainName:

[REQUIRED]

The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Updates a conditional forwarder that has been set up for your AWS directory.

Request Syntax

client.update_conditional_forwarder(
    DirectoryId='string',
    RemoteDomainName='string',
    DnsIpAddrs=[
        'string',
    ]
)

type DirectoryId:

string

param DirectoryId:

[REQUIRED]

The directory ID of the AWS directory for which to update the conditional forwarder.

type RemoteDomainName:

string

param RemoteDomainName:

[REQUIRED]

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

type DnsIpAddrs:

list

param DnsIpAddrs:

[REQUIRED]

The updated IP addresses of the remote DNS server associated with the conditional forwarder.

• (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

Request Syntax

client.create_conditional_forwarder(
    DirectoryId='string',
    RemoteDomainName='string',
    DnsIpAddrs=[
        'string',
    ]
)

type DirectoryId:

string

param DirectoryId:

[REQUIRED]

The directory ID of the AWS directory for which you are creating the conditional forwarder.

type RemoteDomainName:

string

param RemoteDomainName:

[REQUIRED]

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

type DnsIpAddrs:

list

param DnsIpAddrs:

[REQUIRED]

The IP addresses of the remote DNS server associated with RemoteDomainName.

• (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

{'ConditionalForwarderIpAddrs': ['string']}

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.

Request Syntax

client.create_trust(
    DirectoryId='string',
    RemoteDomainName='string',
    TrustPassword='string',
    TrustDirection='One-Way: Outgoing'|'One-Way: Incoming'|'Two-Way',
    TrustType='Forest',
    ConditionalForwarderIpAddrs=[
        'string',
    ]
)

type DirectoryId:

string

param DirectoryId:

[REQUIRED] The Directory ID of the Microsoft AD in the AWS cloud for which to establish the trust relationship.

type RemoteDomainName:

string

param RemoteDomainName:

[REQUIRED] The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

type TrustPassword:

string

param TrustPassword:

[REQUIRED] The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

type TrustDirection:

string

param TrustDirection:

[REQUIRED] The direction of the trust relationship.

type TrustType:

string

param TrustType:

The trust relationship type.

type ConditionalForwarderIpAddrs:

list

param ConditionalForwarderIpAddrs:

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'TrustId': 'string'
}

Response Structure

• (dict) --

  • TrustId (string) -- A unique identifier for the trust relationship that was created.

{'DeleteAssociatedConditionalForwarder': 'boolean'}

Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.

Request Syntax

client.delete_trust(
    TrustId='string',
    DeleteAssociatedConditionalForwarder=True|False
)

type TrustId:

string

param TrustId:

[REQUIRED] The Trust ID of the trust relationship to be deleted.

type DeleteAssociatedConditionalForwarder:

boolean

param DeleteAssociatedConditionalForwarder:

rtype:

dict

returns:

Response Syntax

{
    'TrustId': 'string'
}

Response Structure

• (dict) --

  • TrustId (string) -- The Trust ID of the trust relationship that was deleted.

{'Trusts': {'TrustStateReason': 'string'}}

Obtains information about the trust relationships for this account.

If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.

Request Syntax

client.describe_trusts(
    DirectoryId='string',
    TrustIds=[
        'string',
    ],
    NextToken='string',
    Limit=123
)

type DirectoryId:

string

param DirectoryId:

The Directory ID of the AWS directory that is a part of the requested trust relationship.

type TrustIds:

list

param TrustIds:

A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

• (string) --

type NextToken:

string

param NextToken:

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

type Limit:

integer

param Limit:

The maximum number of objects to return.

rtype:

dict

returns:

Response Syntax

{
    'Trusts': [
        {
            'DirectoryId': 'string',
            'TrustId': 'string',
            'RemoteDomainName': 'string',
            'TrustType': 'Forest',
            'TrustDirection': 'One-Way: Outgoing'|'One-Way: Incoming'|'Two-Way',
            'TrustState': 'Creating'|'Created'|'Verifying'|'VerifyFailed'|'Verified'|'Deleting'|'Deleted'|'Failed',
            'CreatedDateTime': datetime(2015, 1, 1),
            'LastUpdatedDateTime': datetime(2015, 1, 1),
            'StateLastUpdatedDateTime': datetime(2015, 1, 1),
            'TrustStateReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Trusts (list) --

    The list of Trust objects that were retrieved.

    It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

    • (dict) -- Describes a trust relationship between an Microsoft AD in the AWS cloud and an external domain.

      • DirectoryId (string) -- The Directory ID of the AWS directory involved in the trust relationship.

      • TrustId (string) -- The unique ID of the trust relationship.

      • RemoteDomainName (string) -- The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.

      • TrustType (string) -- The trust relationship type.

      • TrustDirection (string) -- The trust relationship direction.

      • TrustState (string) -- The trust relationship state.

      • CreatedDateTime (datetime) -- The date and time that the trust relationship was created.

      • LastUpdatedDateTime (datetime) -- The date and time that the trust relationship was last updated.

      • StateLastUpdatedDateTime (datetime) -- The date and time that the TrustState was last updated.

      • TrustStateReason (string) --

        The reason for the TrustState.

  • NextToken (string) --

    If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items.