Expand description
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.
AWS 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 AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
If you’re using the service, you’re probably looking for DirectoryServiceClient and DirectoryService.
Structs§
- Accept
Shared Directory Request - Accept
Shared Directory Result - AddIp
Routes Request - AddIp
Routes Result - AddTags
ToResource Request - AddTags
ToResource Result - Attribute
Represents a named directory attribute.
- Cancel
Schema Extension Request - Cancel
Schema Extension Result - Certificate
Information about the certificate.
- Certificate
Info Contains general information about a certificate.
- Computer
Contains information about a computer account in a directory.
- Conditional
Forwarder 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.
- Connect
Directory Request Contains the inputs for the ConnectDirectory operation.
- Connect
Directory Result Contains the results of the ConnectDirectory operation.
- Create
Alias Request Contains the inputs for the CreateAlias operation.
- Create
Alias Result Contains the results of the CreateAlias operation.
- Create
Computer Request Contains the inputs for the CreateComputer operation.
- Create
Computer Result Contains the results for the CreateComputer operation.
- Create
Conditional Forwarder Request Initiates the creation of a conditional forwarder for your AWS Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain.
- Create
Conditional Forwarder Result The result of a CreateConditinalForwarder request.
- Create
Directory Request Contains the inputs for the CreateDirectory operation.
- Create
Directory Result Contains the results of the CreateDirectory operation.
- Create
LogSubscription Request - Create
LogSubscription Result - Create
MicrosoftAD Request Creates an AWS Managed Microsoft AD directory.
- Create
MicrosoftAD Result Result of a CreateMicrosoftAD request.
- Create
Snapshot Request Contains the inputs for the CreateSnapshot operation.
- Create
Snapshot Result Contains the results of the CreateSnapshot operation.
- Create
Trust Request AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain.
- Create
Trust Result The result of a CreateTrust request.
- Delete
Conditional Forwarder Request Deletes a conditional forwarder.
- Delete
Conditional Forwarder Result The result of a DeleteConditionalForwarder request.
- Delete
Directory Request Contains the inputs for the DeleteDirectory operation.
- Delete
Directory Result Contains the results of the DeleteDirectory operation.
- Delete
LogSubscription Request - Delete
LogSubscription Result - Delete
Snapshot Request Contains the inputs for the DeleteSnapshot operation.
- Delete
Snapshot Result Contains the results of the DeleteSnapshot operation.
- Delete
Trust Request Deletes the local side of an existing trust relationship between the AWS Managed Microsoft AD directory and the external domain.
- Delete
Trust Result The result of a DeleteTrust request.
- Deregister
Certificate Request - Deregister
Certificate Result - Deregister
Event Topic Request Removes the specified directory as a publisher to the specified SNS topic.
- Deregister
Event Topic Result The result of a DeregisterEventTopic request.
- Describe
Certificate Request - Describe
Certificate Result - Describe
Conditional Forwarders Request Describes a conditional forwarder.
- Describe
Conditional Forwarders Result The result of a DescribeConditionalForwarder request.
- Describe
Directories Request Contains the inputs for the DescribeDirectories operation.
- Describe
Directories Result Contains the results of the DescribeDirectories operation.
- Describe
Domain Controllers Request - Describe
Domain Controllers Result - Describe
Event Topics Request Describes event topics.
- Describe
Event Topics Result The result of a DescribeEventTopic request.
- DescribeLDAPS
Settings Request - DescribeLDAPS
Settings Result - Describe
Shared Directories Request - Describe
Shared Directories Result - Describe
Snapshots Request Contains the inputs for the DescribeSnapshots operation.
- Describe
Snapshots Result Contains the results of the DescribeSnapshots operation.
- Describe
Trusts Request Describes the trust relationships for a particular AWS Managed Microsoft AD directory. If no input parameters are are provided, such as directory ID or trust ID, this request describes all the trust relationships.
- Describe
Trusts Result The result of a DescribeTrust request.
- Directory
Connect Settings Contains information for the ConnectDirectory operation when an AD Connector directory is being created.
- Directory
Connect Settings Description Contains information about an AD Connector directory.
- Directory
Description Contains information about an AWS Directory Service directory.
- Directory
Limits Contains directory limit information for a Region.
- Directory
Service Client - A client for the Directory Service API.
- Directory
VpcSettings Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
- Directory
VpcSettings Description Contains information about the directory.
- DisableLDAPS
Request - DisableLDAPS
Result - Disable
Radius Request Contains the inputs for the DisableRadius operation.
- Disable
Radius Result Contains the results of the DisableRadius operation.
- Disable
SsoRequest Contains the inputs for the DisableSso operation.
- Disable
SsoResult Contains the results of the DisableSso operation.
- Domain
Controller Contains information about the domain controllers for a specified directory.
- EnableLDAPS
Request - EnableLDAPS
Result - Enable
Radius Request Contains the inputs for the EnableRadius operation.
- Enable
Radius Result Contains the results of the EnableRadius operation.
- Enable
SsoRequest Contains the inputs for the EnableSso operation.
- Enable
SsoResult Contains the results of the EnableSso operation.
- Event
Topic Information about SNS topic and AWS Directory Service directory associations.
- GetDirectory
Limits Request Contains the inputs for the GetDirectoryLimits operation.
- GetDirectory
Limits Result Contains the results of the GetDirectoryLimits operation.
- GetSnapshot
Limits Request Contains the inputs for the GetSnapshotLimits operation.
- GetSnapshot
Limits Result Contains the results of the GetSnapshotLimits operation.
- IpRoute
IP address block. This is often the address block of the DNS server used for your on-premises domain.
- IpRoute
Info Information about one or more IP address blocks.
- LDAPS
Setting Info Contains general information about the LDAPS settings.
- List
Certificates Request - List
Certificates Result - List
IpRoutes Request - List
IpRoutes Result - List
LogSubscriptions Request - List
LogSubscriptions Result - List
Schema Extensions Request - List
Schema Extensions Result - List
Tags ForResource Request - List
Tags ForResource Result - LogSubscription
Represents a log subscription, which tracks real-time data from a chosen log group to a specified destination.
- Owner
Directory Description Describes the directory owner account details that have been shared to the directory consumer account.
- Radius
Settings Contains information about a Remote Authentication Dial In User Service (RADIUS) server.
- Register
Certificate Request - Register
Certificate Result - Register
Event Topic Request Registers a new event topic.
- Register
Event Topic Result The result of a RegisterEventTopic request.
- Reject
Shared Directory Request - Reject
Shared Directory Result - Remove
IpRoutes Request - Remove
IpRoutes Result - Remove
Tags From Resource Request - Remove
Tags From Resource Result - Reset
User Password Request - Reset
User Password Result - Restore
From Snapshot Request An object representing the inputs for the RestoreFromSnapshot operation.
- Restore
From Snapshot Result Contains the results of the RestoreFromSnapshot operation.
- Schema
Extension Info Information about a schema extension.
- Share
Directory Request - Share
Directory Result - Share
Target Identifier that contains details about the directory consumer account.
- Shared
Directory Details about the shared directory in the directory owner account for which the share request in the directory consumer account has been accepted.
- Snapshot
Describes a directory snapshot.
- Snapshot
Limits Contains manual snapshot limit information for a directory.
- Start
Schema Extension Request - Start
Schema Extension Result - Tag
Metadata assigned to a directory consisting of a key-value pair.
- Trust
Describes a trust relationship between an AWS Managed Microsoft AD directory and an external domain.
- Unshare
Directory Request - Unshare
Directory Result - Unshare
Target Identifier that contains details about the directory consumer account with whom the directory is being unshared.
- Update
Conditional Forwarder Request Updates a conditional forwarder.
- Update
Conditional Forwarder Result The result of an UpdateConditionalForwarder request.
- Update
Number OfDomain Controllers Request - Update
Number OfDomain Controllers Result - Update
Radius Request Contains the inputs for the UpdateRadius operation.
- Update
Radius Result Contains the results of the UpdateRadius operation.
- Update
Trust Request - Update
Trust Result - Verify
Trust Request Initiates the verification of an existing trust relationship between an AWS Managed Microsoft AD directory and an external domain.
- Verify
Trust Result Result of a VerifyTrust request.
Enums§
- Accept
Shared Directory Error - Errors returned by AcceptSharedDirectory
- AddIp
Routes Error - Errors returned by AddIpRoutes
- AddTags
ToResource Error - Errors returned by AddTagsToResource
- Cancel
Schema Extension Error - Errors returned by CancelSchemaExtension
- Connect
Directory Error - Errors returned by ConnectDirectory
- Create
Alias Error - Errors returned by CreateAlias
- Create
Computer Error - Errors returned by CreateComputer
- Create
Conditional Forwarder Error - Errors returned by CreateConditionalForwarder
- Create
Directory Error - Errors returned by CreateDirectory
- Create
LogSubscription Error - Errors returned by CreateLogSubscription
- Create
MicrosoftAD Error - Errors returned by CreateMicrosoftAD
- Create
Snapshot Error - Errors returned by CreateSnapshot
- Create
Trust Error - Errors returned by CreateTrust
- Delete
Conditional Forwarder Error - Errors returned by DeleteConditionalForwarder
- Delete
Directory Error - Errors returned by DeleteDirectory
- Delete
LogSubscription Error - Errors returned by DeleteLogSubscription
- Delete
Snapshot Error - Errors returned by DeleteSnapshot
- Delete
Trust Error - Errors returned by DeleteTrust
- Deregister
Certificate Error - Errors returned by DeregisterCertificate
- Deregister
Event Topic Error - Errors returned by DeregisterEventTopic
- Describe
Certificate Error - Errors returned by DescribeCertificate
- Describe
Conditional Forwarders Error - Errors returned by DescribeConditionalForwarders
- Describe
Directories Error - Errors returned by DescribeDirectories
- Describe
Domain Controllers Error - Errors returned by DescribeDomainControllers
- Describe
Event Topics Error - Errors returned by DescribeEventTopics
- DescribeLDAPS
Settings Error - Errors returned by DescribeLDAPSSettings
- Describe
Shared Directories Error - Errors returned by DescribeSharedDirectories
- Describe
Snapshots Error - Errors returned by DescribeSnapshots
- Describe
Trusts Error - Errors returned by DescribeTrusts
- DisableLDAPS
Error - Errors returned by DisableLDAPS
- Disable
Radius Error - Errors returned by DisableRadius
- Disable
SsoError - Errors returned by DisableSso
- EnableLDAPS
Error - Errors returned by EnableLDAPS
- Enable
Radius Error - Errors returned by EnableRadius
- Enable
SsoError - Errors returned by EnableSso
- GetDirectory
Limits Error - Errors returned by GetDirectoryLimits
- GetSnapshot
Limits Error - Errors returned by GetSnapshotLimits
- List
Certificates Error - Errors returned by ListCertificates
- List
IpRoutes Error - Errors returned by ListIpRoutes
- List
LogSubscriptions Error - Errors returned by ListLogSubscriptions
- List
Schema Extensions Error - Errors returned by ListSchemaExtensions
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Register
Certificate Error - Errors returned by RegisterCertificate
- Register
Event Topic Error - Errors returned by RegisterEventTopic
- Reject
Shared Directory Error - Errors returned by RejectSharedDirectory
- Remove
IpRoutes Error - Errors returned by RemoveIpRoutes
- Remove
Tags From Resource Error - Errors returned by RemoveTagsFromResource
- Reset
User Password Error - Errors returned by ResetUserPassword
- Restore
From Snapshot Error - Errors returned by RestoreFromSnapshot
- Share
Directory Error - Errors returned by ShareDirectory
- Start
Schema Extension Error - Errors returned by StartSchemaExtension
- Unshare
Directory Error - Errors returned by UnshareDirectory
- Update
Conditional Forwarder Error - Errors returned by UpdateConditionalForwarder
- Update
Number OfDomain Controllers Error - Errors returned by UpdateNumberOfDomainControllers
- Update
Radius Error - Errors returned by UpdateRadius
- Update
Trust Error - Errors returned by UpdateTrust
- Verify
Trust Error - Errors returned by VerifyTrust
Traits§
- Directory
Service - Trait representing the capabilities of the Directory Service API. Directory Service clients implement this trait.