aws_directory_service

AWS Directory Service

AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

Summary

Functions

• accept_shared_directory(Client, Input)
  Accepts a directory sharing request that was sent from the directory owner account.
• accept_shared_directory(Client, Input, Options)
• add_ip_routes(Client, Input)
  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.
• add_ip_routes(Client, Input, Options)
• add_tags_to_resource(Client, Input)
  Adds or overwrites one or more tags for the specified directory.
• add_tags_to_resource(Client, Input, Options)
• cancel_schema_extension(Client, Input)
  Cancels an in-progress schema extension to a Microsoft AD directory.
• cancel_schema_extension(Client, Input, Options)
• connect_directory(Client, Input)
  Creates an AD Connector to connect to an on-premises directory.
• connect_directory(Client, Input, Options)
• create_alias(Client, Input)
  Creates an alias for a directory and assigns the alias to the directory.
• create_alias(Client, Input, Options)
• create_computer(Client, Input)
  Creates a computer account in the specified directory, and joins the computer to the directory.
• create_computer(Client, Input, Options)
• create_conditional_forwarder(Client, Input)
  Creates a conditional forwarder associated with your AWS directory.
• create_conditional_forwarder(Client, Input, Options)
• create_directory(Client, Input)
  Creates a Simple AD directory.
• create_directory(Client, Input, Options)
• create_log_subscription(Client, Input)
  Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your AWS account.
• create_log_subscription(Client, Input, Options)
• create_microsoft_a_d(Client, Input)
  Creates a Microsoft AD directory in the AWS Cloud.
• create_microsoft_a_d(Client, Input, Options)
• create_snapshot(Client, Input)
  Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
• create_snapshot(Client, Input, Options)
• create_trust(Client, Input)
  AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships.
• create_trust(Client, Input, Options)
• delete_conditional_forwarder(Client, Input)
  Deletes a conditional forwarder that has been set up for your AWS directory.
• delete_conditional_forwarder(Client, Input, Options)
• delete_directory(Client, Input)
  Deletes an AWS Directory Service directory.
• delete_directory(Client, Input, Options)
• delete_log_subscription(Client, Input)
  Deletes the specified log subscription.
• delete_log_subscription(Client, Input, Options)
• delete_snapshot(Client, Input)
  Deletes a directory snapshot.
• delete_snapshot(Client, Input, Options)
• delete_trust(Client, Input)
  Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.
• delete_trust(Client, Input, Options)
• deregister_certificate(Client, Input)
  Deletes from the system the certificate that was registered for a secured LDAP connection.
• deregister_certificate(Client, Input, Options)
• deregister_event_topic(Client, Input)
  Removes the specified directory as a publisher to the specified SNS topic.
• deregister_event_topic(Client, Input, Options)
• describe_certificate(Client, Input)
  Displays information about the certificate registered for a secured LDAP connection.
• describe_certificate(Client, Input, Options)
• describe_conditional_forwarders(Client, Input)
  Obtains information about the conditional forwarders for this account.
• describe_conditional_forwarders(Client, Input, Options)
• describe_directories(Client, Input)
  Obtains information about the directories that belong to this account.
• describe_directories(Client, Input, Options)
• describe_domain_controllers(Client, Input)
  Provides information about any domain controllers in your directory.
• describe_domain_controllers(Client, Input, Options)
• describe_event_topics(Client, Input)
  Obtains information about which SNS topics receive status messages from the specified directory.
• describe_event_topics(Client, Input, Options)
• describe_l_d_a_p_s_settings(Client, Input)
  Describes the status of LDAP security for the specified directory.
• describe_l_d_a_p_s_settings(Client, Input, Options)
• describe_shared_directories(Client, Input)
  Returns the shared directories in your account.
• describe_shared_directories(Client, Input, Options)
• describe_snapshots(Client, Input)
  Obtains information about the directory snapshots that belong to this account.
• describe_snapshots(Client, Input, Options)
• describe_trusts(Client, Input)
  Obtains information about the trust relationships for this account.
• describe_trusts(Client, Input, Options)
• disable_l_d_a_p_s(Client, Input)
  Deactivates LDAP secure calls for the specified directory.
• disable_l_d_a_p_s(Client, Input, Options)
• disable_radius(Client, Input)
  Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
• disable_radius(Client, Input, Options)
• disable_sso(Client, Input)
  Disables single-sign on for a directory.
• disable_sso(Client, Input, Options)
• enable_l_d_a_p_s(Client, Input)
  Activates the switch for the specific directory to always use LDAP secure calls.
• enable_l_d_a_p_s(Client, Input, Options)
• enable_radius(Client, Input)
  Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
• enable_radius(Client, Input, Options)
• enable_sso(Client, Input)
  Enables single sign-on for a directory.
• enable_sso(Client, Input, Options)
• get_directory_limits(Client, Input)
  Obtains directory limit information for the current Region.
• get_directory_limits(Client, Input, Options)
• get_snapshot_limits(Client, Input)
  Obtains the manual snapshot limits for a directory.
• get_snapshot_limits(Client, Input, Options)
• list_certificates(Client, Input)
  For the specified directory, lists all the certificates registered for a secured LDAP connection.
• list_certificates(Client, Input, Options)
• list_ip_routes(Client, Input)
  Lists the address blocks that you have added to a directory.
• list_ip_routes(Client, Input, Options)
• list_log_subscriptions(Client, Input)
  Lists the active log subscriptions for the AWS account.
• list_log_subscriptions(Client, Input, Options)
• list_schema_extensions(Client, Input)
  Lists all schema extensions applied to a Microsoft AD Directory.
• list_schema_extensions(Client, Input, Options)
• list_tags_for_resource(Client, Input)
  Lists all tags on a directory.
• list_tags_for_resource(Client, Input, Options)
• register_certificate(Client, Input)
  Registers a certificate for secured LDAP connection.
• register_certificate(Client, Input, Options)
• register_event_topic(Client, Input)
  Associates a directory with an SNS topic.
• register_event_topic(Client, Input, Options)
• reject_shared_directory(Client, Input)
  Rejects a directory sharing request that was sent from the directory owner account.
• reject_shared_directory(Client, Input, Options)
• remove_ip_routes(Client, Input)
  Removes IP address blocks from a directory.
• remove_ip_routes(Client, Input, Options)
• remove_tags_from_resource(Client, Input)
  Removes tags from a directory.
• remove_tags_from_resource(Client, Input, Options)
• reset_user_password(Client, Input)
  Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.
• reset_user_password(Client, Input, Options)
• restore_from_snapshot(Client, Input)
  Restores a directory using an existing directory snapshot.
• restore_from_snapshot(Client, Input, Options)
• share_directory(Client, Input)
  Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer).
• share_directory(Client, Input, Options)
• start_schema_extension(Client, Input)
  Applies a schema extension to a Microsoft AD directory.
• start_schema_extension(Client, Input, Options)
• unshare_directory(Client, Input)
  Stops the directory sharing between the directory owner and consumer accounts.
• unshare_directory(Client, Input, Options)
• update_conditional_forwarder(Client, Input)
  Updates a conditional forwarder that has been set up for your AWS directory.
• update_conditional_forwarder(Client, Input, Options)
• update_number_of_domain_controllers(Client, Input)
  Adds or removes domain controllers to or from the directory.
• update_number_of_domain_controllers(Client, Input, Options)
• update_radius(Client, Input)
  Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
• update_radius(Client, Input, Options)
• update_trust(Client, Input)
  Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.
• update_trust(Client, Input, Options)
• verify_trust(Client, Input)
  AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
• verify_trust(Client, Input, Options)

Functions

Accepts a directory sharing request that was sent from the directory owner account.

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.

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.

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.

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

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://.awsapps.com.

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

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.

Creates a Simple AD directory. For more information, see Simple Active Directory in the AWS Directory Service Admin Guide.

Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your AWS account.

Creates a Microsoft AD directory in the AWS Cloud. For more information, see AWS Managed Microsoft AD in the AWS Directory Service Admin Guide.

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

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.

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

Deletes an AWS Directory Service directory.

Deletes the specified log subscription.

Deletes a directory snapshot.

Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.

Deletes from the system the certificate that was registered for a secured LDAP connection.

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

Displays information about the certificate registered for a secured LDAP connection.

Obtains information about the conditional forwarders for this account.

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.

Provides information about any domain controllers in your directory.

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

Describes the status of LDAP security for the specified directory.

Returns the shared directories in your account.

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.

Obtains information about the trust relationships for this account.

Deactivates LDAP secure calls for the specified directory.

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

Disables single-sign on for a directory.

Activates the switch for the specific directory to always use LDAP secure calls.

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

Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately.

Obtains directory limit information for the current Region.

Obtains the manual snapshot limits for a directory.

For the specified directory, lists all the certificates registered for a secured LDAP connection.

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

Lists the active log subscriptions for the AWS account.

Lists all schema extensions applied to a Microsoft AD Directory.

Lists all tags on a directory.

Registers a certificate for secured LDAP connection.

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.

Rejects a directory sharing request that was sent from the directory owner account.

Removes IP address blocks from a directory.

Removes tags from a directory.

Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.

You can reset the password for any user in your directory with the following exceptions:

• For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.

• For AWS Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the AWS Reserved OU. For more information about the OU structure for an AWS Managed Microsoft AD directory, see What Gets Created in the AWS Directory Service Administration Guide.

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.

Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer). With this operation you can use your directory from any AWS account and from any Amazon VPC within an AWS Region.

When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.

The ShareMethod parameter determines whether the specified directory can be shared between AWS accounts inside the same AWS organization (ORGANIZATIONS). It also determines whether you can share the directory with any other AWS account either inside or outside of the organization (HANDSHAKE).

Applies a schema extension to a Microsoft AD directory.

Stops the directory sharing between the directory owner and consumer accounts.

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

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.

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

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

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