AWS Directory Service
Directory Service Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Directory Service
Directory Service is a web service that makes it easy for you to setup and run directories in the
Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active
Directory. This guide provides detailed information about Directory Service operations, data types,
parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service
Administration Guide .
Amazon Web Services provides SDKs that consist of libraries and sample code for various
programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs
provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services
services. For more information about the Amazon Web Services SDKs, including how to download and
install them, see Tools for Amazon Web
Services .
Endpoints 80
- POSTAccept shared directory
/#X-Amz-Target=DirectoryService_20150416.AcceptSharedDirectoryAccepts a directory sharing request that was sent from the directory owner account. - POSTAdd ip routes
/#X-Amz-Target=DirectoryService_20150416.AddIpRoutesIf 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… - POSTAdd region
/#X-Amz-Target=DirectoryService_20150416.AddRegionAdds two domain controllers in the specified Region for the specified directory. - POSTAdd tags to resource
/#X-Amz-Target=DirectoryService_20150416.AddTagsToResourceAdds 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.… - POSTCancel schema extension
/#X-Amz-Target=DirectoryService_20150416.CancelSchemaExtensionCancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can… - POSTConnect directory
/#X-Amz-Target=DirectoryService_20150416.ConnectDirectoryCreates an AD Connector to connect to a self-managed directory. Before you call ConnectDirectory , ensure that all of the required permissions have been… - POSTCreate alias
/#X-Amz-Target=DirectoryService_20150416.CreateAliasCreates 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://… - POSTCreate computer
/#X-Amz-Target=DirectoryService_20150416.CreateComputerCreates an Active Directory computer object in the specified directory. - POSTCreate conditional forwarder
/#X-Amz-Target=DirectoryService_20150416.CreateConditionalForwarderCreates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust… - POSTCreate directory
/#X-Amz-Target=DirectoryService_20150416.CreateDirectoryCreates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide . Before you call CreateDirectory ,… - POSTCreate hybrid aD
/#X-Amz-Target=DirectoryService_20150416.CreateHybridADCreates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and Amazon Web Services. You must have a successful directory… - POSTCreate log subscription
/#X-Amz-Target=DirectoryService_20150416.CreateLogSubscriptionCreates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web… - POSTCreate microsoft aD
/#X-Amz-Target=DirectoryService_20150416.CreateMicrosoftADCreates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide .… - POSTCreate snapshot
/#X-Amz-Target=DirectoryService_20150416.CreateSnapshotCreates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud. You cannot take snapshots of AD Connector directories. - POSTCreate trust
/#X-Amz-Target=DirectoryService_20150416.CreateTrustDirectory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed… - POSTDelete aD assessment
/#X-Amz-Target=DirectoryService_20150416.DeleteADAssessmentDeletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration… - POSTDelete conditional forwarder
/#X-Amz-Target=DirectoryService_20150416.DeleteConditionalForwarderDeletes a conditional forwarder that has been set up for your Amazon Web Services directory. - POSTDelete directory
/#X-Amz-Target=DirectoryService_20150416.DeleteDirectoryDeletes an Directory Service directory. Before you call DeleteDirectory , ensure that all of the required permissions have been explicitly granted through a… - POSTDelete log subscription
/#X-Amz-Target=DirectoryService_20150416.DeleteLogSubscriptionDeletes the specified log subscription. - POSTDelete snapshot
/#X-Amz-Target=DirectoryService_20150416.DeleteSnapshotDeletes a directory snapshot. - POSTDelete trust
/#X-Amz-Target=DirectoryService_20150416.DeleteTrustDeletes an existing trust relationship between your Managed Microsoft AD directory and an external domain. - POSTDeregister certificate
/#X-Amz-Target=DirectoryService_20150416.DeregisterCertificateDeletes from the system the certificate that was registered for secure LDAP or client certificate authentication. - POSTDeregister event topic
/#X-Amz-Target=DirectoryService_20150416.DeregisterEventTopicRemoves the specified directory as a publisher to the specified Amazon SNS topic. - POSTDescribe aD assessment
/#X-Amz-Target=DirectoryService_20150416.DescribeADAssessmentRetrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. Use this operation… - POSTDescribe cA enrollment policy
/#X-Amz-Target=DirectoryService_20150416.DescribeCAEnrollmentPolicyRetrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory. This policy determines how client… - POSTDescribe certificate
/#X-Amz-Target=DirectoryService_20150416.DescribeCertificateDisplays information about the certificate registered for secure LDAP or client certificate authentication. - POSTDescribe client authentication settings
/#X-Amz-Target=DirectoryService_20150416.DescribeClientAuthenticationSettingsRetrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information… - POSTDescribe conditional forwarders
/#X-Amz-Target=DirectoryService_20150416.DescribeConditionalForwardersObtains information about the conditional forwarders for this account. If no input parameters are provided for RemoteDomainNames, this request describes all… - POSTDescribe directories
/#X-Amz-Target=DirectoryService_20150416.DescribeDirectoriesObtains information about the directories that belong to this account. You can retrieve information about specific directories by passing the directory… - POSTDescribe directory data access
/#X-Amz-Target=DirectoryService_20150416.DescribeDirectoryDataAccessObtains status of directory data access enablement through the Directory Service Data API for the specified directory. - POSTDescribe domain controllers
/#X-Amz-Target=DirectoryService_20150416.DescribeDomainControllersProvides information about any domain controllers in your directory. - POSTDescribe event topics
/#X-Amz-Target=DirectoryService_20150416.DescribeEventTopicsObtains information about which Amazon SNS topics receive status messages from the specified directory. If no input parameters are provided, such as… - POSTDescribe hybrid aD update
/#X-Amz-Target=DirectoryService_20150416.DescribeHybridADUpdateRetrieves information about update activities for a hybrid directory. This operation provides details about configuration changes, administrator account… - POSTDescribe lDAPS settings
/#X-Amz-Target=DirectoryService_20150416.DescribeLDAPSSettingsDescribes the status of LDAP security for the specified directory. - POSTDescribe regions
/#X-Amz-Target=DirectoryService_20150416.DescribeRegionsProvides information about the Regions that are configured for multi-Region replication. - POSTDescribe settings
/#X-Amz-Target=DirectoryService_20150416.DescribeSettingsRetrieves information about the configurable settings for the specified directory. - POSTDescribe shared directories
/#X-Amz-Target=DirectoryService_20150416.DescribeSharedDirectoriesReturns the shared directories in your account. - POSTDescribe snapshots
/#X-Amz-Target=DirectoryService_20150416.DescribeSnapshotsObtains information about the directory snapshots that belong to this account. This operation supports pagination with the use of the NextToken request and… - POSTDescribe trusts
/#X-Amz-Target=DirectoryService_20150416.DescribeTrustsObtains information about the trust relationships for this account. If no input parameters are provided, such as DirectoryId or TrustIds, this request… - POSTDescribe update directory
/#X-Amz-Target=DirectoryService_20150416.DescribeUpdateDirectoryDescribes the updates of a directory for a particular update type. - POSTDisable cA enrollment policy
/#X-Amz-Target=DirectoryService_20150416.DisableCAEnrollmentPolicyDisables the certificate authority (CA) enrollment policy for the specified directory. This stops automatic certificate enrollment and management for… - POSTDisable client authentication
/#X-Amz-Target=DirectoryService_20150416.DisableClientAuthenticationDisables alternative client authentication methods for the specified directory. - POSTDisable directory data access
/#X-Amz-Target=DirectoryService_20150416.DisableDirectoryDataAccessDeactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API… - POSTDisable lDAPS
/#X-Amz-Target=DirectoryService_20150416.DisableLDAPSDeactivates LDAP secure calls for the specified directory. - POSTDisable radius
/#X-Amz-Target=DirectoryService_20150416.DisableRadiusDisables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. - POSTDisable sso
/#X-Amz-Target=DirectoryService_20150416.DisableSsoDisables single-sign on for a directory. - POSTEnable cA enrollment policy
/#X-Amz-Target=DirectoryService_20150416.EnableCAEnrollmentPolicyEnables certificate authority (CA) enrollment policy for the specified directory. This allows domain-joined clients to automatically request and receive… - POSTEnable client authentication
/#X-Amz-Target=DirectoryService_20150416.EnableClientAuthenticationEnables alternative client authentication methods for the specified directory. - POSTEnable directory data access
/#X-Amz-Target=DirectoryService_20150416.EnableDirectoryDataAccessEnables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API… - POSTEnable lDAPS
/#X-Amz-Target=DirectoryService_20150416.EnableLDAPSActivates the switch for the specific directory to always use LDAP secure calls. - POSTEnable radius
/#X-Amz-Target=DirectoryService_20150416.EnableRadiusEnables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. - POSTEnable sso
/#X-Amz-Target=DirectoryService_20150416.EnableSsoEnables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to… - POSTGet directory limits
/#X-Amz-Target=DirectoryService_20150416.GetDirectoryLimitsObtains directory limit information for the current Region. - POSTGet snapshot limits
/#X-Amz-Target=DirectoryService_20150416.GetSnapshotLimitsObtains the manual snapshot limits for a directory. - POSTList aD assessments
/#X-Amz-Target=DirectoryService_20150416.ListADAssessmentsRetrieves a list of directory assessments for the specified directory or all assessments in your account. Use this operation to monitor assessment status and… - POSTList certificates
/#X-Amz-Target=DirectoryService_20150416.ListCertificatesFor the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication. - POSTList ip routes
/#X-Amz-Target=DirectoryService_20150416.ListIpRoutesLists the address blocks that you have added to a directory. - POSTList log subscriptions
/#X-Amz-Target=DirectoryService_20150416.ListLogSubscriptionsLists the active log subscriptions for the Amazon Web Services account. - POSTList schema extensions
/#X-Amz-Target=DirectoryService_20150416.ListSchemaExtensionsLists all schema extensions applied to a Microsoft AD Directory. - POSTList tags for resource
/#X-Amz-Target=DirectoryService_20150416.ListTagsForResourceLists all tags on a directory. - POSTRegister certificate
/#X-Amz-Target=DirectoryService_20150416.RegisterCertificateRegisters a certificate for a secure LDAP or client certificate authentication. - POSTRegister event topic
/#X-Amz-Target=DirectoryService_20150416.RegisterEventTopicAssociates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email… - POSTReject shared directory
/#X-Amz-Target=DirectoryService_20150416.RejectSharedDirectoryRejects a directory sharing request that was sent from the directory owner account. - POSTRemove ip routes
/#X-Amz-Target=DirectoryService_20150416.RemoveIpRoutesRemoves IP address blocks from a directory. - POSTRemove region
/#X-Amz-Target=DirectoryService_20150416.RemoveRegionStops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the… - POSTRemove tags from resource
/#X-Amz-Target=DirectoryService_20150416.RemoveTagsFromResourceRemoves tags from a directory. - POSTReset user password
/#X-Amz-Target=DirectoryService_20150416.ResetUserPasswordResets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled users will become enabled and can be authenticated following… - POSTRestore from snapshot
/#X-Amz-Target=DirectoryService_20150416.RestoreFromSnapshotRestores a directory using an existing directory snapshot. When you restore a directory from a snapshot, any changes made to the directory after the snapshot… - POSTShare directory
/#X-Amz-Target=DirectoryService_20150416.ShareDirectoryShares a specified directory ( DirectoryId ) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory… - POSTStart aD assessment
/#X-Amz-Target=DirectoryService_20150416.StartADAssessmentInitiates a directory assessment to validate your self-managed AD environment for hybrid domain join. The assessment checks compatibility and connectivity of… - POSTStart schema extension
/#X-Amz-Target=DirectoryService_20150416.StartSchemaExtensionApplies a schema extension to a Microsoft AD directory. - POSTUnshare directory
/#X-Amz-Target=DirectoryService_20150416.UnshareDirectoryStops the directory sharing between the directory owner and consumer accounts. - POSTUpdate conditional forwarder
/#X-Amz-Target=DirectoryService_20150416.UpdateConditionalForwarderUpdates a conditional forwarder that has been set up for your Amazon Web Services directory. - POSTUpdate directory setup
/#X-Amz-Target=DirectoryService_20150416.UpdateDirectorySetupUpdates directory configuration for the specified update type. - POSTUpdate hybrid aD
/#X-Amz-Target=DirectoryService_20150416.UpdateHybridADUpdates the configuration of an existing hybrid directory. You can recover hybrid directory administrator account or modify self-managed instance settings.… - POSTUpdate number of domain controllers
/#X-Amz-Target=DirectoryService_20150416.UpdateNumberOfDomainControllersAdds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call),… - POSTUpdate radius
/#X-Amz-Target=DirectoryService_20150416.UpdateRadiusUpdates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory. - POSTUpdate settings
/#X-Amz-Target=DirectoryService_20150416.UpdateSettingsUpdates the configurable settings for the specified directory. - POSTUpdate trust
/#X-Amz-Target=DirectoryService_20150416.UpdateTrustUpdates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory. - POSTVerify trust
/#X-Amz-Target=DirectoryService_20150416.VerifyTrustDirectory Service for Microsoft Active Directory allows you to configure and verify trust relationships. This action verifies a trust relationship between…
API details
- Base URL
https://ds.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 80 operations on 80 pathsPOST 80
- Description format
- AWS Smithy model, API version
2015-04-16 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Directory Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Directory Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Accept shared directory” (POST /#X-Amz-Target=DirectoryService_20150416.AcceptSharedDirectory), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Directory Service?
Directory Service Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your… It is listed under Developer tools and has 80 endpoints.
Who publishes the AWS Directory Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Directory Service?
Requests go to https://ds.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Directory Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Directory Service have?
80 operations on 80 paths (80 POST).
Is forking the AWS Directory Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.