DirectoryService

Table of Contents

Client

class DirectoryService.Client

A low-level client representing AWS Directory Service:

client = session.create_client('ds')

These are the available methods:

add_ip_routes(**kwargs)

If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.

Before you call AddIpRoutes , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .

See also: AWS API Documentation

Request Syntax

response = client.add_ip_routes(
    DirectoryId='string',
    IpRoutes=[
        {
            'CidrIp': 'string',
            'Description': 'string'
        },
    ],
    UpdateSecurityGroupForDirectoryControllers=True|False
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    Identifier (ID) of the directory to which to add the address block.

  • IpRoutes (list) --

    [REQUIRED]

    IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain.

    • (dict) --

      IP address block. This is often the address block of the DNS server used for your on-premises domain.

      • CidrIp (string) --

        IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your on-premises domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32.

      • Description (string) --

        Description of the address block.

  • UpdateSecurityGroupForDirectoryControllers (boolean) --

    If set to true, updates the inbound and outbound rules of the security group that has the description: "AWS created security group for directory ID directory controllers." Following are the new rules:

    Inbound:

    • Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0
    • Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0
    • Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0
    • Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0
    • Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0
    • Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0
    • Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0
    • Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0
    • Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0
    • Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0
    • Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0
    • Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0
    • Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0
    • Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0
    • Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0
    • Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0
    • Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0

    Outbound:

    • Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0

    These security rules impact an internal network interface that is not exposed publicly.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

add_tags_to_resource(**kwargs)

Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.

See also: AWS API Documentation

Request Syntax

response = client.add_tags_to_resource(
    ResourceId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceId (string) --

    [REQUIRED]

    Identifier (ID) for the directory to which to add the tag.

  • Tags (list) --

    [REQUIRED]

    The tags to be assigned to the directory.

    • (dict) --

      Metadata assigned to a directory consisting of a key-value pair.

      • Key (string) -- [REQUIRED]

        Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

      • Value (string) -- [REQUIRED]

        The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
cancel_schema_extension(**kwargs)

Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing , CreatingSnapshot , and UpdatingSchema .

See also: AWS API Documentation

Request Syntax

response = client.cancel_schema_extension(
    DirectoryId='string',
    SchemaExtensionId='string'
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The identifier of the directory whose schema extension will be canceled.

  • SchemaExtensionId (string) --

    [REQUIRED]

    The identifier of the schema extension that will be canceled.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

connect_directory(**kwargs)

Creates an AD Connector to connect to an on-premises directory.

Before you call ConnectDirectory , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .

See also: AWS API Documentation

Request Syntax

response = client.connect_directory(
    Name='string',
    ShortName='string',
    Password='string',
    Description='string',
    Size='Small'|'Large',
    ConnectSettings={
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ],
        'CustomerDnsIps': [
            'string',
        ],
        'CustomerUserName': 'string'
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    The fully-qualified name of the on-premises directory, such as corp.example.com .

  • ShortName (string) -- The NetBIOS name of the on-premises directory, such as CORP .
  • Password (string) --

    [REQUIRED]

    The password for the on-premises user account.

  • Description (string) -- A textual description for the directory.
  • Size (string) --

    [REQUIRED]

    The size of the directory.

  • ConnectSettings (dict) --

    [REQUIRED]

    A DirectoryConnectSettings object that contains additional information for the operation.

    • VpcId (string) -- [REQUIRED]

      The identifier of the VPC in which the AD Connector is created.

    • SubnetIds (list) -- [REQUIRED]

      A list of subnet identifiers in the VPC in which the AD Connector is created.

      • (string) --
    • CustomerDnsIps (list) -- [REQUIRED]

      A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory.

      • (string) --
    • CustomerUserName (string) -- [REQUIRED]

      The username of an account in the on-premises directory that is used to connect to the directory. This account must have the following privileges:

      • Read users and groups
      • Create computer objects
      • Join computers to the domain
Return type

dict

Returns

Response Syntax

{
    'DirectoryId': 'string'
}

Response Structure

  • (dict) --

    Contains the results of the ConnectDirectory operation.

    • DirectoryId (string) --

      The identifier of the new directory.

create_alias(**kwargs)

Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://alias.awsapps.com .

Warning

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

See also: AWS API Documentation

Request Syntax

response = client.create_alias(
    DirectoryId='string',
    Alias='string'
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The identifier of the directory for which to create the alias.

  • Alias (string) --

    [REQUIRED]

    The requested alias.

    The alias must be unique amongst all aliases in AWS. This operation throws an EntityAlreadyExistsException error if the alias already exists.

Return type

dict

Returns

Response Syntax

{
    'DirectoryId': 'string',
    'Alias': 'string'
}

Response Structure

  • (dict) --

    Contains the results of the CreateAlias operation.

    • DirectoryId (string) --

      The identifier of the directory.

    • Alias (string) --

      The alias for the directory.

create_computer(**kwargs)

Creates a computer account in the specified directory, and joins the computer to the directory.

See also: AWS API Documentation

Request Syntax

response = client.create_computer(
    DirectoryId='string',
    ComputerName='string',
    Password='string',
    OrganizationalUnitDistinguishedName='string',
    ComputerAttributes=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The identifier of the directory in which to create the computer account.

  • ComputerName (string) --

    [REQUIRED]

    The name of the computer account.

  • Password (string) --

    [REQUIRED]

    A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.

  • OrganizationalUnitDistinguishedName (string) -- The fully-qualified distinguished name of the organizational unit to place the computer account in.
  • ComputerAttributes (list) --

    An array of Attribute objects that contain any LDAP attributes to apply to the computer account.

    • (dict) --

      Represents a named directory attribute.

      • Name (string) --

        The name of the attribute.

      • Value (string) --

        The value of the attribute.

Return type

dict

Returns

Response Syntax

{
    'Computer': {
        'ComputerId': 'string',
        'ComputerName': 'string',
        'ComputerAttributes': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    Contains the results for the CreateComputer operation.

    • Computer (dict) --

      A Computer object that represents the computer account.

      • ComputerId (string) --

        The identifier of the computer.

      • ComputerName (string) --

        The computer name.

      • ComputerAttributes (list) --

        An array of Attribute objects containing the LDAP attributes that belong to the computer account.

        • (dict) --

          Represents a named directory attribute.

          • Name (string) --

            The name of the attribute.

          • Value (string) --

            The value of the attribute.

create_conditional_forwarder(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_conditional_forwarder(
    DirectoryId='string',
    RemoteDomainName='string',
    DnsIpAddrs=[
        'string',
    ]
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

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

  • RemoteDomainName (string) --

    [REQUIRED]

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

  • DnsIpAddrs (list) --

    [REQUIRED]

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

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    The result of a CreateConditinalForwarder request.

create_directory(**kwargs)

Creates a Simple AD directory.

Before you call CreateDirectory , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .

See also: AWS API Documentation

Request Syntax

response = client.create_directory(
    Name='string',
    ShortName='string',
    Password='string',
    Description='string',
    Size='Small'|'Large',
    VpcSettings={
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ]
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    The fully qualified name for the directory, such as corp.example.com .

  • ShortName (string) -- The short name of the directory, such as CORP .
  • Password (string) --

    [REQUIRED]

    The password for the directory administrator. The directory creation process creates a directory administrator account with the username Administrator and this password.

  • Description (string) -- A textual description for the directory.
  • Size (string) --

    [REQUIRED]

    The size of the directory.

  • VpcSettings (dict) --

    A DirectoryVpcSettings object that contains additional information for the operation.

    • VpcId (string) -- [REQUIRED]

      The identifier of the VPC in which to create the directory.

    • SubnetIds (list) -- [REQUIRED]

      The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.

      • (string) --
Return type

dict

Returns

Response Syntax

{
    'DirectoryId': 'string'
}

Response Structure

  • (dict) --

    Contains the results of the CreateDirectory operation.

    • DirectoryId (string) --

      The identifier of the directory that was created.

create_microsoft_ad(**kwargs)

Creates a Microsoft AD in the AWS cloud.

Before you call CreateMicrosoftAD , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .

See also: AWS API Documentation

Request Syntax

response = client.create_microsoft_ad(
    Name='string',
    ShortName='string',
    Password='string',
    Description='string',
    VpcSettings={
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ]
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    The fully qualified domain name for the directory, such as corp.example.com . This name will resolve inside your VPC only. It does not need to be publicly resolvable.

  • ShortName (string) -- The NetBIOS name for your domain. A short identifier for your domain, such as CORP . If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com .
  • Password (string) --

    [REQUIRED]

    The password for the default administrative user named Admin .

  • Description (string) -- A textual description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.
  • VpcSettings (dict) --

    [REQUIRED]

    Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

    • VpcId (string) -- [REQUIRED]

      The identifier of the VPC in which to create the directory.

    • SubnetIds (list) -- [REQUIRED]

      The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.

      • (string) --
Return type

dict

Returns

Response Syntax

{
    'DirectoryId': 'string'
}

Response Structure

  • (dict) --

    Result of a CreateMicrosoftAD request.

    • DirectoryId (string) --

      The identifier of the directory that was created.

create_snapshot(**kwargs)

Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.

Note

You cannot take snapshots of AD Connector directories.

See also: AWS API Documentation

Request Syntax

response = client.create_snapshot(
    DirectoryId='string',
    Name='string'
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The identifier of the directory of which to take a snapshot.

  • Name (string) -- The descriptive name to apply to the snapshot.
Return type

dict

Returns

Response Syntax

{
    'SnapshotId': 'string'
}

Response Structure

  • (dict) --

    Contains the results of the CreateSnapshot operation.

    • SnapshotId (string) --

      The identifier of the snapshot that was created.

create_trust(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

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

  • RemoteDomainName (string) --

    [REQUIRED]

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

  • TrustPassword (string) --

    [REQUIRED]

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

  • TrustDirection (string) --

    [REQUIRED]

    The direction of the trust relationship.

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

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

    • (string) --
Return type

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.

delete_conditional_forwarder(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_conditional_forwarder(
    DirectoryId='string',
    RemoteDomainName='string'
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

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

  • RemoteDomainName (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    The result of a DeleteConditionalForwarder request.

delete_directory(**kwargs)

Deletes an AWS Directory Service directory.

Before you call DeleteDirectory , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .

See also: AWS API Documentation

Request Syntax

response = client.delete_directory(
    DirectoryId='string'
)
Parameters
DirectoryId (string) --

[REQUIRED]

The identifier of the directory to delete.

Return type
dict
Returns
Response Syntax
{
    'DirectoryId': 'string'
}

Response Structure

  • (dict) --

    Contains the results of the DeleteDirectory operation.

    • DirectoryId (string) --

      The directory identifier.

delete_snapshot(**kwargs)

Deletes a directory snapshot.

See also: AWS API Documentation

Request Syntax

response = client.delete_snapshot(
    SnapshotId='string'
)
Parameters
SnapshotId (string) --

[REQUIRED]

The identifier of the directory snapshot to be deleted.

Return type
dict
Returns
Response Syntax
{
    'SnapshotId': 'string'
}

Response Structure

  • (dict) --

    Contains the results of the DeleteSnapshot operation.

    • SnapshotId (string) --

      The identifier of the directory snapshot that was deleted.

delete_trust(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_trust(
    TrustId='string',
    DeleteAssociatedConditionalForwarder=True|False
)
Parameters
  • TrustId (string) --

    [REQUIRED]

    The Trust ID of the trust relationship to be deleted.

  • DeleteAssociatedConditionalForwarder (boolean) -- Delete a conditional forwarder as part of a DeleteTrustRequest.
Return type

dict

Returns

Response Syntax

{
    'TrustId': 'string'
}

Response Structure

  • (dict) --

    The result of a DeleteTrust request.

    • TrustId (string) --

      The Trust ID of the trust relationship that was deleted.

deregister_event_topic(**kwargs)

Removes the specified directory as a publisher to the specified SNS topic.

See also: AWS API Documentation

Request Syntax

response = client.deregister_event_topic(
    DirectoryId='string',
    TopicName='string'
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic.

  • TopicName (string) --

    [REQUIRED]

    The name of the SNS topic from which to remove the directory as a publisher.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    The result of a DeregisterEventTopic request.

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

describe_directories(**kwargs)

Obtains information about the directories that belong to this account.

You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

See also: AWS API Documentation

Request Syntax

response = client.describe_directories(
    DirectoryIds=[
        'string',
    ],
    NextToken='string',
    Limit=123
)
Parameters
  • DirectoryIds (list) --

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

    An empty list results in an InvalidParameterException being thrown.

    • (string) --
  • NextToken (string) -- The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories . Pass null if this is the first call.
  • Limit (integer) -- The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
Return type

dict

Returns

Response Syntax

{
    'DirectoryDescriptions': [
        {
            'DirectoryId': 'string',
            'Name': 'string',
            'ShortName': 'string',
            'Size': 'Small'|'Large',
            'Alias': 'string',
            'AccessUrl': 'string',
            'Description': 'string',
            'DnsIpAddrs': [
                'string',
            ],
            'Stage': 'Requested'|'Creating'|'Created'|'Active'|'Inoperable'|'Impaired'|'Restoring'|'RestoreFailed'|'Deleting'|'Deleted'|'Failed',
            'LaunchTime': datetime(2015, 1, 1),
            'StageLastUpdatedDateTime': datetime(2015, 1, 1),
            'Type': 'SimpleAD'|'ADConnector'|'MicrosoftAD',
            'VpcSettings': {
                'VpcId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupId': 'string',
                'AvailabilityZones': [
                    'string',
                ]
            },
            'ConnectSettings': {
                'VpcId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'CustomerUserName': 'string',
                'SecurityGroupId': 'string',
                'AvailabilityZones': [
                    'string',
                ],
                'ConnectIps': [
                    'string',
                ]
            },
            'RadiusSettings': {
                'RadiusServers': [
                    'string',
                ],
                'RadiusPort': 123,
                'RadiusTimeout': 123,
                'RadiusRetries': 123,
                'SharedSecret': 'string',
                'AuthenticationProtocol': 'PAP'|'CHAP'|'MS-CHAPv1'|'MS-CHAPv2',
                'DisplayLabel': 'string',
                'UseSameUsername': True|False
            },
            'RadiusStatus': 'Creating'|'Completed'|'Failed',
            'StageReason': 'string',
            'SsoEnabled': True|False,
            'DesiredNumberOfDomainControllers': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Contains the results of the DescribeDirectories operation.

    • DirectoryDescriptions (list) --

      The list of DirectoryDescription 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) --

        Contains information about an AWS Directory Service directory.

        • DirectoryId (string) --

          The directory identifier.

        • Name (string) --

          The fully-qualified name of the directory.

        • ShortName (string) --

          The short name of the directory.

        • Size (string) --

          The directory size.

        • Alias (string) --

          The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX .

        • AccessUrl (string) --

          The access URL for the directory, such as http://alias.awsapps.com . If no alias has been created for the directory, alias is the directory identifier, such as d-XXXXXXXXXX .

        • Description (string) --

          The textual description for the directory.

        • DnsIpAddrs (list) --

          The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.

          • (string) --
        • Stage (string) --

          The current stage of the directory.

        • LaunchTime (datetime) --

          Specifies when the directory was created.

        • StageLastUpdatedDateTime (datetime) --

          The date and time that the stage was last updated.

        • Type (string) --

          The directory size.

        • VpcSettings (dict) --

          A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory.

          • VpcId (string) --

            The identifier of the VPC that the directory is in.

          • SubnetIds (list) --

            The identifiers of the subnets for the directory servers.

            • (string) --
          • SecurityGroupId (string) --

            The security group identifier for the directory. If the directory was created before 8/1/2014, this is the identifier of the directory members security group that was created when the directory was created. If the directory was created after this date, this value is null.

          • AvailabilityZones (list) --

            The list of Availability Zones that the directory is in.

            • (string) --
        • ConnectSettings (dict) --

          A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.

          • VpcId (string) --

            The identifier of the VPC that the AD Connector is in.

          • SubnetIds (list) --

            A list of subnet identifiers in the VPC that the AD connector is in.

            • (string) --
          • CustomerUserName (string) --

            The username of the service account in the on-premises directory.

          • SecurityGroupId (string) --

            The security group identifier for the AD Connector directory.

          • AvailabilityZones (list) --

            A list of the Availability Zones that the directory is in.

            • (string) --
          • ConnectIps (list) --

            The IP addresses of the AD Connector servers.

            • (string) --
        • RadiusSettings (dict) --

          A RadiusSettings object that contains information about the RADIUS server configured for this directory.

          • RadiusServers (list) --

            An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

            • (string) --
          • RadiusPort (integer) --

            The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.

          • RadiusTimeout (integer) --

            The amount of time, in seconds, to wait for the RADIUS server to respond.

          • RadiusRetries (integer) --

            The maximum number of times that communication with the RADIUS server is attempted.

          • SharedSecret (string) --

            Not currently used.

          • AuthenticationProtocol (string) --

            The protocol specified for your RADIUS endpoints.

          • DisplayLabel (string) --

            Not currently used.

          • UseSameUsername (boolean) --

            Not currently used.

        • RadiusStatus (string) --

          The status of the RADIUS MFA server connection.

        • StageReason (string) --

          Additional information about the directory stage.

        • SsoEnabled (boolean) --

          Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso .

        • DesiredNumberOfDomainControllers (integer) --

          The desired number of domain controllers in the directory if the directory is Microsoft AD.

    • NextToken (string) --

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

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.

describe_event_topics(**kwargs)

Obtains information about which SNS topics receive status messages from the specified directory.

If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.

See also: AWS API Documentation

Request Syntax

response = client.describe_event_topics(
    DirectoryId='string',
    TopicNames=[
        'string',
    ]
)
Parameters
  • DirectoryId (string) -- The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.
  • TopicNames (list) --

    A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.

    An empty list results in an InvalidParameterException being thrown.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'EventTopics': [
        {
            'DirectoryId': 'string',
            'TopicName': 'string',
            'TopicArn': 'string',
            'CreatedDateTime': datetime(2015, 1, 1),
            'Status': 'Registered'|'Topic not found'|'Failed'|'Deleted'
        },
    ]
}

Response Structure

  • (dict) --

    The result of a DescribeEventTopic request.

    • EventTopics (list) --

      A list of SNS topic names that receive status messages from the specified Directory ID.

      • (dict) --

        Information about SNS topic and AWS Directory Service directory associations.

        • DirectoryId (string) --

          The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.

        • TopicName (string) --

          The name of an AWS SNS topic the receives status messages from the directory.

        • TopicArn (string) --

          The SNS topic ARN (Amazon Resource Name).

        • CreatedDateTime (datetime) --

          The date and time of when you associated your directory with the SNS topic.

        • Status (string) --

          The topic registration status.

describe_snapshots(**kwargs)

Obtains information about the directory snapshots that belong to this account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

See also: AWS API Documentation

Request Syntax

response = client.describe_snapshots(
    DirectoryId='string',
    SnapshotIds=[
        'string',
    ],
    NextToken='string',
    Limit=123
)
Parameters
  • DirectoryId (string) -- The identifier of the directory for which to retrieve snapshot information.
  • SnapshotIds (list) --

    A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

    • (string) --
  • NextToken (string) -- The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots . Pass null if this is the first call.
  • Limit (integer) -- The maximum number of objects to return.
Return type

dict

Returns

Response Syntax

{
    'Snapshots': [
        {
            'DirectoryId': 'string',
            'SnapshotId': 'string',
            'Type': 'Auto'|'Manual',
            'Name': 'string',
            'Status': 'Creating'|'Completed'|'Failed',
            'StartTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Contains the results of the DescribeSnapshots operation.

    • Snapshots (list) --

      The list of Snapshot 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 directory snapshot.

        • DirectoryId (string) --

          The directory identifier.

        • SnapshotId (string) --

          The snapshot identifier.

        • Type (string) --

          The snapshot type.

        • Name (string) --

          The descriptive name of the snapshot.

        • Status (string) --

          The snapshot status.

        • StartTime (datetime) --

          The date and time that the snapshot was taken.

    • NextToken (string) --

      If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots .

describe_trusts(**kwargs)

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

response = client.describe_trusts(
    DirectoryId='string',
    TrustIds=[
        'string',
    ],
    NextToken='string',
    Limit=123
)
Parameters
  • DirectoryId (string) -- The Directory ID of the AWS directory that is a part of the requested trust relationship.
  • TrustIds (list) --

    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) --
  • NextToken (string) -- The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts . Pass null if this is the first call.
  • Limit (integer) -- The maximum number of objects to return.
Return type

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

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

disable_radius(**kwargs)

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

See also: AWS API Documentation

Request Syntax

response = client.disable_radius(
    DirectoryId='string'
)
Parameters
DirectoryId (string) --

[REQUIRED]

The identifier of the directory for which to disable MFA.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

    Contains the results of the DisableRadius operation.

disable_sso(**kwargs)

Disables single-sign on for a directory.

See also: AWS API Documentation

Request Syntax

response = client.disable_sso(
    DirectoryId='string',
    UserName='string',
    Password='string'
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The identifier of the directory for which to disable single-sign on.

  • UserName (string) --

    The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.

    If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.

  • Password (string) -- The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    Contains the results of the DisableSso operation.

enable_radius(**kwargs)

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

See also: AWS API Documentation

Request Syntax

response = client.enable_radius(
    DirectoryId='string',
    RadiusSettings={
        'RadiusServers': [
            'string',
        ],
        'RadiusPort': 123,
        'RadiusTimeout': 123,
        'RadiusRetries': 123,
        'SharedSecret': 'string',
        'AuthenticationProtocol': 'PAP'|'CHAP'|'MS-CHAPv1'|'MS-CHAPv2',
        'DisplayLabel': 'string',
        'UseSameUsername': True|False
    }
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The identifier of the directory for which to enable MFA.

  • RadiusSettings (dict) --

    [REQUIRED]

    A RadiusSettings object that contains information about the RADIUS server.

    • RadiusServers (list) --

      An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

      • (string) --
    • RadiusPort (integer) --

      The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.

    • RadiusTimeout (integer) --

      The amount of time, in seconds, to wait for the RADIUS server to respond.

    • RadiusRetries (integer) --

      The maximum number of times that communication with the RADIUS server is attempted.

    • SharedSecret (string) --

      Not currently used.

    • AuthenticationProtocol (string) --

      The protocol specified for your RADIUS endpoints.

    • DisplayLabel (string) --

      Not currently used.

    • UseSameUsername (boolean) --

      Not currently used.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    Contains the results of the EnableRadius operation.

enable_sso(**kwargs)

Enables single sign-on for a directory.

See also: AWS API Documentation

Request Syntax

response = client.enable_sso(
    DirectoryId='string',
    UserName='string',
    Password='string'
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The identifier of the directory for which to enable single-sign on.

  • UserName (string) --

    The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.

    If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.

  • Password (string) -- The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    Contains the results of the EnableSso operation.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_directory_limits()

Obtains directory limit information for the current region.

See also: AWS API Documentation

Request Syntax

response = client.get_directory_limits()
Return type
dict
Returns
Response Syntax
{
    'DirectoryLimits': {
        'CloudOnlyDirectoriesLimit': 123,
        'CloudOnlyDirectoriesCurrentCount': 123,
        'CloudOnlyDirectoriesLimitReached': True|False,
        'CloudOnlyMicrosoftADLimit': 123,
        'CloudOnlyMicrosoftADCurrentCount': 123,
        'CloudOnlyMicrosoftADLimitReached': True|False,
        'ConnectedDirectoriesLimit': 123,
        'ConnectedDirectoriesCurrentCount': 123,
        'ConnectedDirectoriesLimitReached': True|False
    }
}

Response Structure

  • (dict) --

    Contains the results of the GetDirectoryLimits operation.

    • DirectoryLimits (dict) --

      A DirectoryLimits object that contains the directory limits for the current region.

      • CloudOnlyDirectoriesLimit (integer) --

        The maximum number of cloud directories allowed in the region.

      • CloudOnlyDirectoriesCurrentCount (integer) --

        The current number of cloud directories in the region.

      • CloudOnlyDirectoriesLimitReached (boolean) --

        Indicates if the cloud directory limit has been reached.

      • CloudOnlyMicrosoftADLimit (integer) --

        The maximum number of Microsoft AD directories allowed in the region.

      • CloudOnlyMicrosoftADCurrentCount (integer) --

        The current number of Microsoft AD directories in the region.

      • CloudOnlyMicrosoftADLimitReached (boolean) --

        Indicates if the Microsoft AD directory limit has been reached.

      • ConnectedDirectoriesLimit (integer) --

        The maximum number of connected directories allowed in the region.

      • ConnectedDirectoriesCurrentCount (integer) --

        The current number of connected directories in the region.

      • ConnectedDirectoriesLimitReached (boolean) --

        Indicates if the connected directory limit has been reached.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_snapshot_limits(**kwargs)

Obtains the manual snapshot limits for a directory.

See also: AWS API Documentation

Request Syntax

response = client.get_snapshot_limits(
    DirectoryId='string'
)
Parameters
DirectoryId (string) --

[REQUIRED]

Contains the identifier of the directory to obtain the limits for.

Return type
dict
Returns
Response Syntax
{
    'SnapshotLimits': {
        'ManualSnapshotsLimit': 123,
        'ManualSnapshotsCurrentCount': 123,
        'ManualSnapshotsLimitReached': True|False
    }
}

Response Structure

  • (dict) --

    Contains the results of the GetSnapshotLimits operation.

    • SnapshotLimits (dict) --

      A SnapshotLimits object that contains the manual snapshot limits for the specified directory.

      • ManualSnapshotsLimit (integer) --

        The maximum number of manual snapshots allowed.

      • ManualSnapshotsCurrentCount (integer) --

        The current number of manual snapshots of the directory.

      • ManualSnapshotsLimitReached (boolean) --

        Indicates if the manual snapshot limit has been reached.

get_waiter(waiter_name)
list_ip_routes(**kwargs)

Lists the address blocks that you have added to a directory.

See also: AWS API Documentation

Request Syntax

response = client.list_ip_routes(
    DirectoryId='string',
    NextToken='string',
    Limit=123
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    Identifier (ID) of the directory for which you want to retrieve the IP addresses.

  • NextToken (string) -- The ListIpRoutes.NextToken value from a previous call to ListIpRoutes . Pass null if this is the first call.
  • Limit (integer) -- Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
Return type

dict

Returns

Response Syntax

{
    'IpRoutesInfo': [
        {
            'DirectoryId': 'string',
            'CidrIp': 'string',
            'IpRouteStatusMsg': 'Adding'|'Added'|'Removing'|'Removed'|'AddFailed'|'RemoveFailed',
            'AddedDateTime': datetime(2015, 1, 1),
            'IpRouteStatusReason': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • IpRoutesInfo (list) --

      A list of IpRoute s.

      • (dict) --

        Information about one or more IP address blocks.

        • DirectoryId (string) --

          Identifier (ID) of the directory associated with the IP addresses.

        • CidrIp (string) --

          IP address block in the IpRoute .

        • IpRouteStatusMsg (string) --

          The status of the IP address block.

        • AddedDateTime (datetime) --

          The date and time the address block was added to the directory.

        • IpRouteStatusReason (string) --

          The reason for the IpRouteStatusMsg.

        • Description (string) --

          Description of the IpRouteInfo .

    • NextToken (string) --

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

list_schema_extensions(**kwargs)

Lists all schema extensions applied to a Microsoft AD Directory.

See also: AWS API Documentation

Request Syntax

response = client.list_schema_extensions(
    DirectoryId='string',
    NextToken='string',
    Limit=123
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The identifier of the directory from which to retrieve the schema extension information.

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

dict

Returns

Response Syntax

{
    'SchemaExtensionsInfo': [
        {
            'DirectoryId': 'string',
            'SchemaExtensionId': 'string',
            'Description': 'string',
            'SchemaExtensionStatus': 'Initializing'|'CreatingSnapshot'|'UpdatingSchema'|'Replicating'|'CancelInProgress'|'RollbackInProgress'|'Cancelled'|'Failed'|'Completed',
            'SchemaExtensionStatusReason': 'string',
            'StartDateTime': datetime(2015, 1, 1),
            'EndDateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • SchemaExtensionsInfo (list) --

      Information about the schema extensions applied to the directory.

      • (dict) --

        Information about a schema extension.

        • DirectoryId (string) --

          The identifier of the directory to which the schema extension is applied.

        • SchemaExtensionId (string) --

          The identifier of the schema extension.

        • Description (string) --

          A description of the schema extension.

        • SchemaExtensionStatus (string) --

          The current status of the schema extension.

        • SchemaExtensionStatusReason (string) --

          The reason for the SchemaExtensionStatus .

        • StartDateTime (datetime) --

          The date and time that the schema extension started being applied to the directory.

        • EndDateTime (datetime) --

          The date and time that the schema extension was completed.

    • NextToken (string) --

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

list_tags_for_resource(**kwargs)

Lists all tags on a directory.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceId='string',
    NextToken='string',
    Limit=123
)
Parameters
  • ResourceId (string) --

    [REQUIRED]

    Identifier (ID) of the directory for which you want to retrieve tags.

  • NextToken (string) -- Reserved for future use.
  • Limit (integer) -- Reserved for future use.
Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Tags (list) --

      List of tags returned by the ListTagsForResource operation.

      • (dict) --

        Metadata assigned to a directory consisting of a key-value pair.

        • Key (string) --

          Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

        • Value (string) --

          The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

    • NextToken (string) --

      Reserved for future use.

register_event_topic(**kwargs)

Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.

See also: AWS API Documentation

Request Syntax

response = client.register_event_topic(
    DirectoryId='string',
    TopicName='string'
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The Directory ID that will publish status messages to the SNS topic.

  • TopicName (string) --

    [REQUIRED]

    The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region as the specified Directory ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    The result of a RegisterEventTopic request.

remove_ip_routes(**kwargs)

Removes IP address blocks from a directory.

See also: AWS API Documentation

Request Syntax

response = client.remove_ip_routes(
    DirectoryId='string',
    CidrIps=[
        'string',
    ]
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    Identifier (ID) of the directory from which you want to remove the IP addresses.

  • CidrIps (list) --

    [REQUIRED]

    IP address blocks that you want to remove.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

remove_tags_from_resource(**kwargs)

Removes tags from a directory.

See also: AWS API Documentation

Request Syntax

response = client.remove_tags_from_resource(
    ResourceId='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceId (string) --

    [REQUIRED]

    Identifier (ID) of the directory from which to remove the tag.

  • TagKeys (list) --

    [REQUIRED]

    The tag key (name) of the tag to be removed.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

restore_from_snapshot(**kwargs)

Restores a directory using an existing directory snapshot.

When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.

This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active , the restore operation is complete.

See also: AWS API Documentation

Request Syntax

response = client.restore_from_snapshot(
    SnapshotId='string'
)
Parameters
SnapshotId (string) --

[REQUIRED]

The identifier of the snapshot to restore from.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

    Contains the results of the RestoreFromSnapshot operation.

start_schema_extension(**kwargs)

Applies a schema extension to a Microsoft AD directory.

See also: AWS API Documentation

Request Syntax

response = client.start_schema_extension(
    DirectoryId='string',
    CreateSnapshotBeforeSchemaExtension=True|False,
    LdifContent='string',
    Description='string'
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The identifier of the directory for which the schema extension will be applied to.

  • CreateSnapshotBeforeSchemaExtension (boolean) --

    [REQUIRED]

    If true, creates a snapshot of the directory before applying the schema extension.

  • LdifContent (string) --

    [REQUIRED]

    The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with n. See the example request below for more details. The file size can be no larger than 1MB.

  • Description (string) --

    [REQUIRED]

    A description of the schema extension.

Return type

dict

Returns

Response Syntax

{
    'SchemaExtensionId': 'string'
}

Response Structure

  • (dict) --

    • SchemaExtensionId (string) --

      The identifier of the schema extension that will be applied.

update_conditional_forwarder(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_conditional_forwarder(
    DirectoryId='string',
    RemoteDomainName='string',
    DnsIpAddrs=[
        'string',
    ]
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

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

  • RemoteDomainName (string) --

    [REQUIRED]

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

  • DnsIpAddrs (list) --

    [REQUIRED]

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

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    The result of an UpdateConditionalForwarder request.

update_number_of_domain_controllers(**kwargs)

Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.

See also: AWS API Documentation

Request Syntax

response = client.update_number_of_domain_controllers(
    DirectoryId='string',
    DesiredNumber=123
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    Identifier of the directory to which the domain controllers will be added or removed.

  • DesiredNumber (integer) --

    [REQUIRED]

    The number of domain controllers desired in the directory.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_radius(**kwargs)

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.

See also: AWS API Documentation

Request Syntax

response = client.update_radius(
    DirectoryId='string',
    RadiusSettings={
        'RadiusServers': [
            'string',
        ],
        'RadiusPort': 123,
        'RadiusTimeout': 123,
        'RadiusRetries': 123,
        'SharedSecret': 'string',
        'AuthenticationProtocol': 'PAP'|'CHAP'|'MS-CHAPv1'|'MS-CHAPv2',
        'DisplayLabel': 'string',
        'UseSameUsername': True|False
    }
)
Parameters
  • DirectoryId (string) --

    [REQUIRED]

    The identifier of the directory for which to update the RADIUS server information.

  • RadiusSettings (dict) --

    [REQUIRED]

    A RadiusSettings object that contains information about the RADIUS server.

    • RadiusServers (list) --

      An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

      • (string) --
    • RadiusPort (integer) --

      The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.

    • RadiusTimeout (integer) --

      The amount of time, in seconds, to wait for the RADIUS server to respond.

    • RadiusRetries (integer) --

      The maximum number of times that communication with the RADIUS server is attempted.

    • SharedSecret (string) --

      Not currently used.

    • AuthenticationProtocol (string) --

      The protocol specified for your RADIUS endpoints.

    • DisplayLabel (string) --

      Not currently used.

    • UseSameUsername (boolean) --

      Not currently used.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    Contains the results of the UpdateRadius operation.

verify_trust(**kwargs)

AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.

See also: AWS API Documentation

Request Syntax

response = client.verify_trust(
    TrustId='string'
)
Parameters
TrustId (string) --

[REQUIRED]

The unique Trust ID of the trust relationship to verify.

Return type
dict
Returns
Response Syntax
{
    'TrustId': 'string'
}

Response Structure

  • (dict) --

    Result of a VerifyTrust request.

    • TrustId (string) --

      The unique Trust ID of the trust relationship that was verified.

Paginators

The available paginators are: