AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 

Classes

NameDescription
Class Attribute Represents a named directory attribute.
Class AuthenticationFailedException DirectoryService exception
Class ClientException DirectoryService exception
Class Computer Contains information about a computer account in a directory.
Class ConnectDirectoryRequest Container for the parameters to the ConnectDirectory operation. Creates an AD Connector to connect to an on-premises directory.
Class ConnectDirectoryResponse Configuration for accessing Amazon ConnectDirectory service
Class ConnectDirectoryResult Contains the results of the ConnectDirectory operation.
Class CreateAliasRequest Container for the parameters to the CreateAlias operation. 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.

Class CreateAliasResponse Configuration for accessing Amazon CreateAlias service
Class CreateAliasResult Contains the results of the CreateAlias operation.
Class CreateComputerRequest Container for the parameters to the CreateComputer operation. Creates a computer account in the specified directory, and joins the computer to the directory.
Class CreateComputerResponse Configuration for accessing Amazon CreateComputer service
Class CreateComputerResult Contains the results for the CreateComputer operation.
Class CreateDirectoryRequest Container for the parameters to the CreateDirectory operation. Creates a Simple AD directory.
Class CreateDirectoryResponse Configuration for accessing Amazon CreateDirectory service
Class CreateDirectoryResult Contains the results of the CreateDirectory operation.
Class CreateMicrosoftADRequest Container for the parameters to the CreateMicrosoftAD operation. Creates a Microsoft AD in the AWS cloud.
Class CreateMicrosoftADResponse Configuration for accessing Amazon CreateMicrosoftAD service
Class CreateMicrosoftADResult
Class CreateSnapshotRequest Container for the parameters to the CreateSnapshot operation. Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.

You cannot take snapshots of AD Connector directories.

Class CreateSnapshotResponse Configuration for accessing Amazon CreateSnapshot service
Class CreateSnapshotResult Contains the results of the CreateSnapshot operation.
Class CreateTrustRequest Container for the parameters to the CreateTrust operation. 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.

Class CreateTrustResponse Configuration for accessing Amazon CreateTrust service
Class CreateTrustResult
Class DeleteDirectoryRequest Container for the parameters to the DeleteDirectory operation. Deletes an AWS Directory Service directory.
Class DeleteDirectoryResponse Configuration for accessing Amazon DeleteDirectory service
Class DeleteDirectoryResult Contains the results of the DeleteDirectory operation.
Class DeleteSnapshotRequest Container for the parameters to the DeleteSnapshot operation. Deletes a directory snapshot.
Class DeleteSnapshotResponse Configuration for accessing Amazon DeleteSnapshot service
Class DeleteSnapshotResult Contains the results of the DeleteSnapshot operation.
Class DeleteTrustRequest Container for the parameters to the DeleteTrust operation. Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
Class DeleteTrustResponse Configuration for accessing Amazon DeleteTrust service
Class DeleteTrustResult
Class DeregisterEventTopicRequest Container for the parameters to the DeregisterEventTopic operation. Removes the specified directory as a publisher to the specified SNS topic.
Class DeregisterEventTopicResponse Configuration for accessing Amazon DeregisterEventTopic service
Class DeregisterEventTopicResult
Class DescribeDirectoriesRequest Container for the parameters to the DescribeDirectories operation. 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.

Class DescribeDirectoriesResponse Configuration for accessing Amazon DescribeDirectories service
Class DescribeDirectoriesResult Contains the results of the DescribeDirectories operation.
Class DescribeEventTopicsRequest Container for the parameters to the DescribeEventTopics operation. 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.

Class DescribeEventTopicsResponse Configuration for accessing Amazon DescribeEventTopics service
Class DescribeEventTopicsResult
Class DescribeSnapshotsRequest Container for the parameters to the DescribeSnapshots operation. 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.

Class DescribeSnapshotsResponse Configuration for accessing Amazon DescribeSnapshots service
Class DescribeSnapshotsResult Contains the results of the DescribeSnapshots operation.
Class DescribeTrustsRequest Container for the parameters to the DescribeTrusts operation. 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.

Class DescribeTrustsResponse Configuration for accessing Amazon DescribeTrusts service
Class DescribeTrustsResult
Class DirectoryConnectSettings Contains information for the ConnectDirectory operation when an AD Connector directory is being created.
Class DirectoryConnectSettingsDescription Contains information about an AD Connector directory.
Class DirectoryDescription Contains information about an AWS Directory Service directory.
Class DirectoryLimitExceededException DirectoryService exception
Class DirectoryLimits Contains directory limit information for a region.
Class DirectoryUnavailableException DirectoryService exception
Class DirectoryVpcSettings Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
Class DirectoryVpcSettingsDescription Contains information about the directory.
Class DisableRadiusRequest Container for the parameters to the DisableRadius operation. Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
Class DisableRadiusResponse Configuration for accessing Amazon DisableRadius service
Class DisableRadiusResult Contains the results of the DisableRadius operation.
Class DisableSsoRequest Container for the parameters to the DisableSso operation. Disables single-sign on for a directory.
Class DisableSsoResponse Configuration for accessing Amazon DisableSso service
Class DisableSsoResult Contains the results of the DisableSso operation.
Class EnableRadiusRequest Container for the parameters to the EnableRadius operation. Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
Class EnableRadiusResponse Configuration for accessing Amazon EnableRadius service
Class EnableRadiusResult Contains the results of the EnableRadius operation.
Class EnableSsoRequest Container for the parameters to the EnableSso operation. Enables single-sign on for a directory.
Class EnableSsoResponse Configuration for accessing Amazon EnableSso service
Class EnableSsoResult Contains the results of the EnableSso operation.
Class EntityAlreadyExistsException DirectoryService exception
Class EntityDoesNotExistException DirectoryService exception
Class EventTopic Information about SNS topic and AWS Directory Service directory associations.
Class GetDirectoryLimitsRequest Container for the parameters to the GetDirectoryLimits operation. Obtains directory limit information for the current region.
Class GetDirectoryLimitsResponse Configuration for accessing Amazon GetDirectoryLimits service
Class GetDirectoryLimitsResult Contains the results of the GetDirectoryLimits operation.
Class GetSnapshotLimitsRequest Container for the parameters to the GetSnapshotLimits operation. Obtains the manual snapshot limits for a directory.
Class GetSnapshotLimitsResponse Configuration for accessing Amazon GetSnapshotLimits service
Class GetSnapshotLimitsResult Contains the results of the GetSnapshotLimits operation.
Class InsufficientPermissionsException DirectoryService exception
Class InvalidNextTokenException DirectoryService exception
Class InvalidParameterException DirectoryService exception
Class RadiusSettings Contains information about a Remote Authentication Dial In User Service (RADIUS) server.
Class RegisterEventTopicRequest Container for the parameters to the RegisterEventTopic operation. 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.
Class RegisterEventTopicResponse Configuration for accessing Amazon RegisterEventTopic service
Class RegisterEventTopicResult
Class RestoreFromSnapshotRequest Container for the parameters to the RestoreFromSnapshot operation. 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 Active, the restore operation is complete.

Class RestoreFromSnapshotResponse Configuration for accessing Amazon RestoreFromSnapshot service
Class RestoreFromSnapshotResult Contains the results of the RestoreFromSnapshot operation.
Class ServiceException DirectoryService exception
Class Snapshot Describes a directory snapshot.
Class SnapshotLimitExceededException DirectoryService exception
Class SnapshotLimits Contains manual snapshot limit information for a directory.
Class Trust Describes a trust relationship between an Microsoft AD in the AWS cloud and an external domain.
Class UnsupportedOperationException DirectoryService exception
Class UpdateRadiusRequest Container for the parameters to the UpdateRadius operation. Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
Class UpdateRadiusResponse Configuration for accessing Amazon UpdateRadius service
Class UpdateRadiusResult Contains the results of the UpdateRadius operation.
Class VerifyTrustRequest Container for the parameters to the VerifyTrust operation. 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.

Class VerifyTrustResponse Configuration for accessing Amazon VerifyTrust service
Class VerifyTrustResult