This is the AWS Directory Service API Reference. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors.
Inheritance Hierarchy
Namespace: Amazon.DirectoryService
Assembly: AWSSDK.dll
Version: (assembly version)
Syntax
public interface IAmazonDirectoryService IDisposable
The IAmazonDirectoryService type exposes the following members
Methods
| Name | Description | |
|---|---|---|
|
BeginConnectDirectory(ConnectDirectoryRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ConnectDirectory operation. |
|
|
BeginCreateAlias(CreateAliasRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateAlias operation. |
|
|
BeginCreateComputer(CreateComputerRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateComputer operation. |
|
|
BeginCreateDirectory(CreateDirectoryRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDirectory operation. |
|
|
BeginCreateMicrosoftAD(CreateMicrosoftADRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateMicrosoftAD operation. |
|
|
BeginCreateSnapshot(CreateSnapshotRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateSnapshot operation. |
|
|
BeginCreateTrust(CreateTrustRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateTrust operation. |
|
|
BeginDeleteDirectory(DeleteDirectoryRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteDirectory operation. |
|
|
BeginDeleteSnapshot(DeleteSnapshotRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteSnapshot operation. |
|
|
BeginDeleteTrust(DeleteTrustRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteTrust operation. |
|
|
BeginDeregisterEventTopic(DeregisterEventTopicRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeregisterEventTopic operation. |
|
|
BeginDescribeDirectories(DescribeDirectoriesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDirectories operation. |
|
|
BeginDescribeEventTopics(DescribeEventTopicsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeEventTopics operation. |
|
|
BeginDescribeSnapshots(DescribeSnapshotsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeSnapshots operation. |
|
|
BeginDescribeTrusts(DescribeTrustsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeTrusts operation. |
|
|
BeginDisableRadius(DisableRadiusRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DisableRadius operation. |
|
|
BeginDisableSso(DisableSsoRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DisableSso operation. |
|
|
BeginEnableRadius(EnableRadiusRequest, AsyncCallback, object) | Initiates the asynchronous execution of the EnableRadius operation. |
|
|
BeginEnableSso(EnableSsoRequest, AsyncCallback, object) | Initiates the asynchronous execution of the EnableSso operation. |
|
|
BeginGetDirectoryLimits(GetDirectoryLimitsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetDirectoryLimits operation. |
|
|
BeginGetSnapshotLimits(GetSnapshotLimitsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetSnapshotLimits operation. |
|
|
BeginRegisterEventTopic(RegisterEventTopicRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RegisterEventTopic operation. |
|
|
BeginRestoreFromSnapshot(RestoreFromSnapshotRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RestoreFromSnapshot operation. |
|
|
BeginUpdateRadius(UpdateRadiusRequest, AsyncCallback, object) | Initiates the asynchronous execution of the UpdateRadius operation. |
|
|
BeginVerifyTrust(VerifyTrustRequest, AsyncCallback, object) | Initiates the asynchronous execution of the VerifyTrust operation. |
|
|
ConnectDirectory(ConnectDirectoryRequest) | Creates an AD Connector to connect to an on-premises directory. |
|
|
CreateAlias(CreateAliasRequest) |
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.
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. |
|
|
CreateComputer(CreateComputerRequest) | Creates a computer account in the specified directory, and joins the computer to the directory. |
|
|
CreateDirectory(CreateDirectoryRequest) | Creates a Simple AD directory. |
|
|
CreateMicrosoftAD(CreateMicrosoftADRequest) | Creates a Microsoft AD in the AWS cloud. |
|
|
CreateSnapshot(CreateSnapshotRequest) |
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
You cannot take snapshots of AD Connector directories. |
|
|
CreateTrust(CreateTrustRequest) |
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. |
|
|
DeleteDirectory(DeleteDirectoryRequest) | Deletes an AWS Directory Service directory. |
|
|
DeleteSnapshot(DeleteSnapshotRequest) | Deletes a directory snapshot. |
|
|
DeleteTrust(DeleteTrustRequest) | Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain. |
|
|
DeregisterEventTopic(DeregisterEventTopicRequest) | Removes the specified directory as a publisher to the specified SNS topic. |
|
|
DescribeDirectories() |
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. |
|
|
DescribeDirectories(DescribeDirectoriesRequest) |
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. |
|
|
DescribeEventTopics(DescribeEventTopicsRequest) |
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. |
|
|
DescribeSnapshots(DescribeSnapshotsRequest) |
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. |
|
|
DescribeTrusts(DescribeTrustsRequest) |
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. |
|
|
DisableRadius(DisableRadiusRequest) | Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. |
|
|
DisableSso(DisableSsoRequest) | Disables single-sign on for a directory. |
|
|
EnableRadius(EnableRadiusRequest) | Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. |
|
|
EnableSso(EnableSsoRequest) | Enables single-sign on for a directory. |
|
|
EndConnectDirectory(IAsyncResult) | Finishes the asynchronous execution of the ConnectDirectory operation. |
|
|
EndCreateAlias(IAsyncResult) | Finishes the asynchronous execution of the CreateAlias operation. |
|
|
EndCreateComputer(IAsyncResult) | Finishes the asynchronous execution of the CreateComputer operation. |
|
|
EndCreateDirectory(IAsyncResult) | Finishes the asynchronous execution of the CreateDirectory operation. |
|
|
EndCreateMicrosoftAD(IAsyncResult) | Finishes the asynchronous execution of the CreateMicrosoftAD operation. |
|
|
EndCreateSnapshot(IAsyncResult) | Finishes the asynchronous execution of the CreateSnapshot operation. |
|
|
EndCreateTrust(IAsyncResult) | Finishes the asynchronous execution of the CreateTrust operation. |
|
|
EndDeleteDirectory(IAsyncResult) | Finishes the asynchronous execution of the DeleteDirectory operation. |
|
|
EndDeleteSnapshot(IAsyncResult) | Finishes the asynchronous execution of the DeleteSnapshot operation. |
|
|
EndDeleteTrust(IAsyncResult) | Finishes the asynchronous execution of the DeleteTrust operation. |
|
|
EndDeregisterEventTopic(IAsyncResult) | Finishes the asynchronous execution of the DeregisterEventTopic operation. |
|
|
EndDescribeDirectories(IAsyncResult) | Finishes the asynchronous execution of the DescribeDirectories operation. |
|
|
EndDescribeEventTopics(IAsyncResult) | Finishes the asynchronous execution of the DescribeEventTopics operation. |
|
|
EndDescribeSnapshots(IAsyncResult) | Finishes the asynchronous execution of the DescribeSnapshots operation. |
|
|
EndDescribeTrusts(IAsyncResult) | Finishes the asynchronous execution of the DescribeTrusts operation. |
|
|
EndDisableRadius(IAsyncResult) | Finishes the asynchronous execution of the DisableRadius operation. |
|
|
EndDisableSso(IAsyncResult) | Finishes the asynchronous execution of the DisableSso operation. |
|
|
EndEnableRadius(IAsyncResult) | Finishes the asynchronous execution of the EnableRadius operation. |
|
|
EndEnableSso(IAsyncResult) | Finishes the asynchronous execution of the EnableSso operation. |
|
|
EndGetDirectoryLimits(IAsyncResult) | Finishes the asynchronous execution of the GetDirectoryLimits operation. |
|
|
EndGetSnapshotLimits(IAsyncResult) | Finishes the asynchronous execution of the GetSnapshotLimits operation. |
|
|
EndRegisterEventTopic(IAsyncResult) | Finishes the asynchronous execution of the RegisterEventTopic operation. |
|
|
EndRestoreFromSnapshot(IAsyncResult) | Finishes the asynchronous execution of the RestoreFromSnapshot operation. |
|
|
EndUpdateRadius(IAsyncResult) | Finishes the asynchronous execution of the UpdateRadius operation. |
|
|
EndVerifyTrust(IAsyncResult) | Finishes the asynchronous execution of the VerifyTrust operation. |
|
|
GetDirectoryLimits() | Obtains directory limit information for the current region. |
|
|
GetDirectoryLimits(GetDirectoryLimitsRequest) | Obtains directory limit information for the current region. |
|
|
GetSnapshotLimits(GetSnapshotLimitsRequest) | Obtains the manual snapshot limits for a directory. |
|
|
RegisterEventTopic(RegisterEventTopicRequest) | 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. |
|
|
RestoreFromSnapshot(RestoreFromSnapshotRequest) |
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 |
|
|
UpdateRadius(UpdateRadiusRequest) | Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory. |
|
|
VerifyTrust(VerifyTrustRequest) |
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. |
Version Information
.NET Framework:
Supported in: 4.5, 4.0, 3.5