# AWS Directory Service API Reference > 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 self-managed 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. - [Welcome](https://docs.aws.amazon.com/directoryservice/latest/devguide/Welcome.md) - [Common Error Types](https://docs.aws.amazon.com/directoryservice/latest/devguide/CommonErrors.md) ## [Actions](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_Operations.md) - [AcceptSharedDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_AcceptSharedDirectory.md): Accepts a directory sharing request that was sent from the directory owner account. - [AddIpRoutes](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_AddIpRoutes.md): If the DNS server for your self-managed 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. - [AddRegion](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_AddRegion.md): Adds two domain controllers in the specified Region for the specified directory. - [AddTagsToResource](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_AddTagsToResource.md): Adds or overwrites one or more tags for the specified directory. - [CancelSchemaExtension](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CancelSchemaExtension.md): Cancels an in-progress schema extension to a Microsoft AD directory. - [ConnectDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ConnectDirectory.md): Creates an AD Connector to connect to a self-managed directory. - [CreateAlias](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateAlias.md): Creates an alias for a directory and assigns the alias to the directory. - [CreateComputer](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateComputer.md): Creates an Active Directory computer object in the specified directory. - [CreateConditionalForwarder](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateConditionalForwarder.md): Creates a conditional forwarder associated with your AWS directory. - [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.md) - [CreateHybridAD](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateHybridAD.md): Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and AWS. - [CreateLogSubscription](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateLogSubscription.md): Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your AWS account. - [CreateMicrosoftAD](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateMicrosoftAD.md): Creates a Microsoft AD directory in the AWS Cloud. - [CreateSnapshot](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateSnapshot.md): Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. - [CreateTrust](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateTrust.md): AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. - [DeleteADAssessment](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DeleteADAssessment.md): Deletes a directory assessment and all associated data. - [DeleteConditionalForwarder](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DeleteConditionalForwarder.md): Deletes a conditional forwarder that has been set up for your AWS directory. - [DeleteDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DeleteDirectory.md): Deletes an AWS Directory Service directory. - [DeleteLogSubscription](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DeleteLogSubscription.md): Deletes the specified log subscription. - [DeleteSnapshot](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DeleteSnapshot.md): Deletes a directory snapshot. - [DeleteTrust](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DeleteTrust.md): Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain. - [DeregisterCertificate](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DeregisterCertificate.md): Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication. - [DeregisterEventTopic](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DeregisterEventTopic.md): Removes the specified directory as a publisher to the specified Amazon SNS topic. - [DescribeADAssessment](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeADAssessment.md): Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. - [DescribeCAEnrollmentPolicy](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeCAEnrollmentPolicy.md): Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory. - [DescribeCertificate](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeCertificate.md): Displays information about the certificate registered for secure LDAP or client certificate authentication. - [DescribeClientAuthenticationSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeClientAuthenticationSettings.md): Retrieves information about the type of client authentication for the specified directory, if the type is specified. - [DescribeConditionalForwarders](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeConditionalForwarders.md): Obtains information about the conditional forwarders for this account. - [DescribeDirectories](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeDirectories.md): Obtains information about the directories that belong to this account. - [DescribeDirectoryDataAccess](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeDirectoryDataAccess.md): Obtains status of directory data access enablement through the Directory Service Data API for the specified directory. - [DescribeDomainControllers](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeDomainControllers.md): Provides information about any domain controllers in your directory. - [DescribeEventTopics](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeEventTopics.md): Obtains information about which Amazon SNS topics receive status messages from the specified directory. - [DescribeHybridADUpdate](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeHybridADUpdate.md): Retrieves information about update activities for a hybrid directory. - [DescribeLDAPSSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeLDAPSSettings.md): Describes the status of LDAP security for the specified directory. - [DescribeRegions](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeRegions.md): Provides information about the Regions that are configured for multi-Region replication. - [DescribeSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeSettings.md): Retrieves information about the configurable settings for the specified directory. - [DescribeSharedDirectories](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeSharedDirectories.md): Returns the shared directories in your account. - [DescribeSnapshots](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeSnapshots.md): Obtains information about the directory snapshots that belong to this account. - [DescribeTrusts](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeTrusts.md): Obtains information about the trust relationships for this account. - [DescribeUpdateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DescribeUpdateDirectory.md): Describes the updates of a directory for a particular update type. - [DisableCAEnrollmentPolicy](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DisableCAEnrollmentPolicy.md): Disables the certificate authority (CA) enrollment policy for the specified directory. - [DisableClientAuthentication](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DisableClientAuthentication.md): Disables alternative client authentication methods for the specified directory. - [DisableDirectoryDataAccess](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DisableDirectoryDataAccess.md): Deactivates access to directory data via the Directory Service Data API for the specified directory. - [DisableLDAPS](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DisableLDAPS.md): Deactivates LDAP secure calls for the specified directory. - [DisableRadius](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DisableRadius.md): Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. - [DisableSso](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DisableSso.md): Disables single-sign on for a directory. - [EnableCAEnrollmentPolicy](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_EnableCAEnrollmentPolicy.md): Enables certificate authority (CA) enrollment policy for the specified directory. - [EnableClientAuthentication](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_EnableClientAuthentication.md): Enables alternative client authentication methods for the specified directory. - [EnableDirectoryDataAccess](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_EnableDirectoryDataAccess.md): Enables access to directory data via the Directory Service Data API for the specified directory. - [EnableLDAPS](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_EnableLDAPS.md): Activates the switch for the specific directory to always use LDAP secure calls. - [EnableRadius](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_EnableRadius.md): Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. - [EnableSso](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_EnableSso.md): Enables single sign-on for a directory. - [GetDirectoryLimits](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_GetDirectoryLimits.md): Obtains directory limit information for the current Region. - [GetSnapshotLimits](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_GetSnapshotLimits.md): Obtains the manual snapshot limits for a directory. - [ListADAssessments](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ListADAssessments.md): Retrieves a list of directory assessments for the specified directory or all assessments in your account. - [ListCertificates](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ListCertificates.md): For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication. - [ListIpRoutes](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ListIpRoutes.md): Lists the address blocks that you have added to a directory. - [ListLogSubscriptions](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ListLogSubscriptions.md): Lists the active log subscriptions for the AWS account. - [ListSchemaExtensions](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ListSchemaExtensions.md): Lists all schema extensions applied to a Microsoft AD Directory. - [ListTagsForResource](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ListTagsForResource.md): Lists all tags on a directory. - [RegisterCertificate](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_RegisterCertificate.md): Registers a certificate for a secure LDAP or client certificate authentication. - [RegisterEventTopic](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_RegisterEventTopic.md): Associates a directory with an Amazon SNS topic. - [RejectSharedDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_RejectSharedDirectory.md): Rejects a directory sharing request that was sent from the directory owner account. - [RemoveIpRoutes](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_RemoveIpRoutes.md): Removes IP address blocks from a directory. - [RemoveRegion](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_RemoveRegion.md): Stops all replication and removes the domain controllers from the specified Region. - [RemoveTagsFromResource](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_RemoveTagsFromResource.md): Removes tags from a directory. - [ResetUserPassword](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.md): Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory. - [RestoreFromSnapshot](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_RestoreFromSnapshot.md): Restores a directory using an existing directory snapshot. - [ShareDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ShareDirectory.md): Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer). - [StartADAssessment](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_StartADAssessment.md): Initiates a directory assessment to validate your self-managed AD environment for hybrid domain join. - [StartSchemaExtension](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_StartSchemaExtension.md): Applies a schema extension to a Microsoft AD directory. - [UnshareDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_UnshareDirectory.md): Stops the directory sharing between the directory owner and consumer accounts. - [UpdateConditionalForwarder](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_UpdateConditionalForwarder.md): Updates a conditional forwarder that has been set up for your AWS directory. - [UpdateDirectorySetup](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_UpdateDirectorySetup.md): Updates directory configuration for the specified update type. - [UpdateHybridAD](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_UpdateHybridAD.md): Updates the configuration of an existing hybrid directory. - [UpdateNumberOfDomainControllers](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_UpdateNumberOfDomainControllers.md): Adds or removes domain controllers to or from the directory. - [UpdateRadius](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_UpdateRadius.md): Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory. - [UpdateSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_UpdateSettings.md): Updates the configurable settings for the specified directory. - [UpdateTrust](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_UpdateTrust.md): Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an self-managed Active Directory. - [VerifyTrust](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_VerifyTrust.md): AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. ## [Data Types](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_Types.md) - [Assessment](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_Assessment.md): Contains detailed information about a directory assessment, including configuration parameters, status, and validation results. - [AssessmentConfiguration](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_AssessmentConfiguration.md): Contains configuration parameters required to perform a directory assessment. - [AssessmentReport](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_AssessmentReport.md): Contains the results of validation tests performed against a specific domain controller during a directory assessment. - [AssessmentSummary](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_AssessmentSummary.md): Contains summary information about a directory assessment, providing a high-level overview without detailed validation results. - [AssessmentValidation](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_AssessmentValidation.md): Contains information about a specific validation test performed during a directory assessment. - [Attribute](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_Attribute.md): Represents a named directory attribute. - [Certificate](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_Certificate.md): Information about the certificate. - [CertificateInfo](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CertificateInfo.md): Contains general information about a certificate. - [ClientAuthenticationSettingInfo](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ClientAuthenticationSettingInfo.md): Contains information about a client authentication method for a directory. - [ClientCertAuthSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ClientCertAuthSettings.md): Contains information about the client certificate authentication settings for the RegisterCertificate and DescribeCertificate operations. - [Computer](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_Computer.md): Contains information about a computer account in a directory. - [ConditionalForwarder](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ConditionalForwarder.md): Points to a remote domain with which you are setting up a trust relationship. - [DirectoryConnectSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryConnectSettings.md): Contains connection settings for creating an AD Connector with the ConnectDirectory action. - [DirectoryConnectSettingsDescription](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryConnectSettingsDescription.md): Contains information about an AD Connector directory. - [DirectoryDescription](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryDescription.md): Contains information about an AWS Directory Service directory. - [DirectoryLimits](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryLimits.md): Contains directory limit information for a Region. - [DirectorySizeUpdateSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectorySizeUpdateSettings.md): Contains the directory size configuration for update operations. - [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.md): Contains VPC information for the CreateDirectory, CreateMicrosoftAD, or CreateHybridAD operation. - [DirectoryVpcSettingsDescription](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettingsDescription.md): Contains information about the directory. - [DomainController](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DomainController.md): Contains information about the domain controllers for a specified directory. - [EventTopic](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_EventTopic.md): Information about Amazon SNS topic and AWS Directory Service directory associations. - [HybridAdministratorAccountUpdate](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_HybridAdministratorAccountUpdate.md): Use to recover to the hybrid directory administrator account credentials. - [HybridCustomerInstancesSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_HybridCustomerInstancesSettings.md): Contains configuration settings for self-managed instances with SSM used in hybrid directory operations. - [HybridSettingsDescription](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_HybridSettingsDescription.md): Describes the current hybrid directory configuration settings for a directory. - [HybridUpdateActivities](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_HybridUpdateActivities.md): Contains information about update activities for different components of a hybrid directory. - [HybridUpdateInfoEntry](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_HybridUpdateInfoEntry.md): Contains detailed information about a specific update activity for a hybrid directory component. - [HybridUpdateValue](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_HybridUpdateValue.md): Contains the configuration values for a hybrid directory update, including AWS System Manager managed node and DNS information. - [IpRoute](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_IpRoute.md): Contains the IP address block. - [IpRouteInfo](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_IpRouteInfo.md): Information about one or more IP address blocks. - [LDAPSSettingInfo](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_LDAPSSettingInfo.md): Contains general information about the LDAPS settings. - [LogSubscription](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_LogSubscription.md): Represents a log subscription, which tracks real-time data from a chosen log group to a specified destination. - [NetworkUpdateSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_NetworkUpdateSettings.md): Contains the network configuration for directory update operations. - [OSUpdateSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_OSUpdateSettings.md): OS version that the directory needs to be updated to. - [OwnerDirectoryDescription](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_OwnerDirectoryDescription.md): Contains the directory owner account details shared with the directory consumer account. - [RadiusSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_RadiusSettings.md): Contains information about a Remote Authentication Dial In User Service (RADIUS) server. - [RegionDescription](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_RegionDescription.md): The replicated Region information for a directory. - [RegionsInfo](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_RegionsInfo.md): Provides information about the Regions that are configured for multi-Region replication. - [SchemaExtensionInfo](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_SchemaExtensionInfo.md): Information about a schema extension. - [Setting](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_Setting.md): Contains information about the configurable settings for a directory. - [SettingEntry](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_SettingEntry.md): Contains information about the specified configurable setting for a directory. - [SharedDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_SharedDirectory.md): Details about the shared directory in the directory owner account for which the share request in the directory consumer account has been accepted. - [ShareTarget](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ShareTarget.md): Identifier that contains details about the directory consumer account. - [Snapshot](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_Snapshot.md): Describes a directory snapshot. - [SnapshotLimits](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_SnapshotLimits.md): Contains manual snapshot limit information for a directory. - [Tag](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_Tag.md): Metadata assigned to a directory consisting of a key-value pair. - [Trust](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_Trust.md): Describes a trust relationship between an AWS Managed Microsoft AD directory and an external domain. - [UnshareTarget](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_UnshareTarget.md): Identifier that contains details about the directory consumer account with whom the directory is being unshared. - [UpdateInfoEntry](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_UpdateInfoEntry.md): An entry of update information related to a requested update type. - [UpdateValue](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_UpdateValue.md): The value for a given type of UpdateSettings. ## Full content The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass: - [Complete guide (single file)](https://docs.aws.amazon.com/directoryservice/latest/devguide/full.md)