AWS Directory Service

Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.

See also: AWS API Documentation

Request Syntax

client.update_trust(
    TrustId='string',
    SelectiveAuth='Enabled'|'Disabled'
)

type TrustId

string

param TrustId

[REQUIRED]

Identifier of the trust relationship.

type SelectiveAuth

string

param SelectiveAuth

Updates selective authentication for the trust.

rtype

dict

returns

Response Syntax

{
    'RequestId': 'string',
    'TrustId': 'string'
}

Response Structure

• (dict) --

  • RequestId (string) --

    The AWS request identifier.

  • TrustId (string) --

    Identifier of the trust relationship.

{'SelectiveAuth': 'Enabled | Disabled', 'TrustType': ['External']}

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, 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 an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.

See also: AWS API Documentation

Request Syntax

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

type DirectoryId

string

param DirectoryId

[REQUIRED]

The Directory ID of the AWS Managed Microsoft AD directory 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. Forest is the default.

type ConditionalForwarderIpAddrs

list

param ConditionalForwarderIpAddrs

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

• (string) --

type SelectiveAuth

string

param SelectiveAuth

Optional parameter to enable selective authentication for the trust.

rtype

dict

returns

Response Syntax

{
    'TrustId': 'string'
}

Response Structure

• (dict) --

  The result of a CreateTrust request.

  • TrustId (string) --

    A unique identifier for the trust relationship that was created.

{'Trusts': {'SelectiveAuth': 'Enabled | Disabled',
            'TrustState': ['Updated', 'Updating', 'UpdateFailed'],
            'TrustType': ['External']}}

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.

See also: AWS API Documentation

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'|'External',
            'TrustDirection': 'One-Way: Outgoing'|'One-Way: Incoming'|'Two-Way',
            'TrustState': 'Creating'|'Created'|'Verifying'|'VerifyFailed'|'Verified'|'Updating'|'UpdateFailed'|'Updated'|'Deleting'|'Deleted'|'Failed',
            'CreatedDateTime': datetime(2015, 1, 1),
            'LastUpdatedDateTime': datetime(2015, 1, 1),
            'StateLastUpdatedDateTime': datetime(2015, 1, 1),
            'TrustStateReason': 'string',
            'SelectiveAuth': 'Enabled'|'Disabled'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  The result of a DescribeTrust request.

  • 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 AWS Managed Microsoft AD directory 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. Forest is the default.

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

      • SelectiveAuth (string) --

        Current state of selective authentication for the trust.

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