AWS SDK Version 3 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.

Classes

NameDescription
Class AcceptSharedDirectoryRequest

Container for the parameters to the AcceptSharedDirectory operation. Accepts a directory sharing request that was sent from the directory owner account.

Class AcceptSharedDirectoryResponse

This is the response object from the AcceptSharedDirectory operation.

Class AccessDeniedException

DirectoryService exception

Class AddIpRoutesRequest

Container for the parameters to the AddIpRoutes operation. If the DNS server for your on-premises 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. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.

Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Class AddIpRoutesResponse

This is the response object from the AddIpRoutes operation.

Class AddTagsToResourceRequest

Container for the parameters to the AddTagsToResource operation. Adds 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. Tag keys must be unique to each resource.

Class AddTagsToResourceResponse

This is the response object from the AddTagsToResource operation.

Class Attribute

Represents a named directory attribute.

Class AuthenticationFailedException

DirectoryService exception

Class CancelSchemaExtensionRequest

Container for the parameters to the CancelSchemaExtension operation. Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.

Class CancelSchemaExtensionResponse

This is the response object from the CancelSchemaExtension operation.

Class ClientException

DirectoryService exception

Class Computer

Contains information about a computer account in a directory.

Class ConditionalForwarder

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.

Class ConnectDirectoryRequest

Container for the parameters to the ConnectDirectory operation. Creates an AD Connector to connect to an on-premises directory.

Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Class ConnectDirectoryResponse

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://.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

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

Contains the results for the CreateComputer operation.

Class CreateConditionalForwarderRequest

Container for the parameters to the CreateConditionalForwarder operation. Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

Class CreateConditionalForwarderResponse

The result of a CreateConditinalForwarder request.

Class CreateDirectoryRequest

Container for the parameters to the CreateDirectory operation. Creates a Simple AD directory.

Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Class CreateDirectoryResponse

Contains the results of the CreateDirectory operation.

Class CreateLogSubscriptionRequest

Container for the parameters to the CreateLogSubscription operation. Creates a subscription to forward real time Directory Service domain controller security logs to the specified CloudWatch log group in your AWS account.

Class CreateLogSubscriptionResponse

This is the response object from the CreateLogSubscription operation.

Class CreateMicrosoftADRequest

Container for the parameters to the CreateMicrosoftAD operation. Creates an AWS Managed Microsoft AD directory.

Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Class CreateMicrosoftADResponse

Result of a CreateMicrosoftAD request.

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

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 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. You can create either a forest trust or an external trust.

Class CreateTrustResponse

The result of a CreateTrust request.

Class DeleteConditionalForwarderRequest

Container for the parameters to the DeleteConditionalForwarder operation. Deletes a conditional forwarder that has been set up for your AWS directory.

Class DeleteConditionalForwarderResponse

The result of a DeleteConditionalForwarder request.

Class DeleteDirectoryRequest

Container for the parameters to the DeleteDirectory operation. Deletes an AWS Directory Service directory.

Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Class DeleteDirectoryResponse

Contains the results of the DeleteDirectory operation.

Class DeleteLogSubscriptionRequest

Container for the parameters to the DeleteLogSubscription operation. Deletes the specified log subscription.

Class DeleteLogSubscriptionResponse

This is the response object from the DeleteLogSubscription operation.

Class DeleteSnapshotRequest

Container for the parameters to the DeleteSnapshot operation. Deletes a directory snapshot.

Class DeleteSnapshotResponse

Contains the results of the DeleteSnapshot operation.

Class DeleteTrustRequest

Container for the parameters to the DeleteTrust operation. Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.

Class DeleteTrustResponse

The result of a DeleteTrust request.

Class DeregisterEventTopicRequest

Container for the parameters to the DeregisterEventTopic operation. Removes the specified directory as a publisher to the specified SNS topic.

Class DeregisterEventTopicResponse

The result of a DeregisterEventTopic request.

Class DescribeConditionalForwardersRequest

Container for the parameters to the DescribeConditionalForwarders operation. Obtains information about the conditional forwarders for this account.

If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.

Class DescribeConditionalForwardersResponse

The result of a DescribeConditionalForwarder request.

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

Contains the results of the DescribeDirectories operation.

Class DescribeDomainControllersRequest

Container for the parameters to the DescribeDomainControllers operation. Provides information about any domain controllers in your directory.

Class DescribeDomainControllersResponse

This is the response object from the DescribeDomainControllers 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

The result of a DescribeEventTopic request.

Class DescribeSharedDirectoriesRequest

Container for the parameters to the DescribeSharedDirectories operation. Returns the shared directories in your account.

Class DescribeSharedDirectoriesResponse

This is the response object from the DescribeSharedDirectories operation.

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

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

The result of a DescribeTrust request.

Class DirectoryAlreadySharedException

DirectoryService exception

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 DirectoryNotSharedException

DirectoryService exception

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 or Microsoft AD directory.

Class DisableRadiusResponse

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

Contains the results of the DisableSso operation.

Class DomainController

Contains information about the domain controllers for a specified directory.

Class DomainControllerLimitExceededException

DirectoryService exception

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 or Microsoft AD directory.

Class EnableRadiusResponse

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

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

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

Contains the results of the GetSnapshotLimits operation.

Class InsufficientPermissionsException

DirectoryService exception

Class InvalidNextTokenException

DirectoryService exception

Class InvalidParameterException

DirectoryService exception

Class InvalidPasswordException

DirectoryService exception

Class InvalidTargetException

DirectoryService exception

Class IpRoute

IP address block. This is often the address block of the DNS server used for your on-premises domain.

Class IpRouteInfo

Information about one or more IP address blocks.

Class IpRouteLimitExceededException

DirectoryService exception

Class ListIpRoutesRequest

Container for the parameters to the ListIpRoutes operation. Lists the address blocks that you have added to a directory.

Class ListIpRoutesResponse

This is the response object from the ListIpRoutes operation.

Class ListLogSubscriptionsRequest

Container for the parameters to the ListLogSubscriptions operation. Lists the active log subscriptions for the AWS account.

Class ListLogSubscriptionsResponse

This is the response object from the ListLogSubscriptions operation.

Class ListSchemaExtensionsRequest

Container for the parameters to the ListSchemaExtensions operation. Lists all schema extensions applied to a Microsoft AD Directory.

Class ListSchemaExtensionsResponse

This is the response object from the ListSchemaExtensions operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists all tags on a directory.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class LogSubscription

Represents a log subscription, which tracks real-time data from a chosen log group to a specified destination.

Class OrganizationsException

DirectoryService exception

Class OwnerDirectoryDescription

Describes the directory owner account details that have been shared to the directory consumer account.

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

The result of a RegisterEventTopic request.

Class RejectSharedDirectoryRequest

Container for the parameters to the RejectSharedDirectory operation. Rejects a directory sharing request that was sent from the directory owner account.

Class RejectSharedDirectoryResponse

This is the response object from the RejectSharedDirectory operation.

Class RemoveIpRoutesRequest

Container for the parameters to the RemoveIpRoutes operation. Removes IP address blocks from a directory.

Class RemoveIpRoutesResponse

This is the response object from the RemoveIpRoutes operation.

Class RemoveTagsFromResourceRequest

Container for the parameters to the RemoveTagsFromResource operation. Removes tags from a directory.

Class RemoveTagsFromResourceResponse

This is the response object from the RemoveTagsFromResource operation.

Class ResetUserPasswordRequest

Container for the parameters to the ResetUserPassword operation. Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.

Class ResetUserPasswordResponse

This is the response object from the ResetUserPassword operation.

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

Contains the results of the RestoreFromSnapshot operation.

Class SchemaExtensionInfo

Information about a schema extension.

Class ServiceException

DirectoryService exception

Class SharedDirectory

Details about the shared directory in the directory owner account for which the share request in the directory consumer account has been accepted.

Class ShareDirectoryRequest

Container for the parameters to the ShareDirectory operation. Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer). With this operation you can use your directory from any AWS account and from any Amazon VPC within an AWS Region.

When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.

The ShareMethod parameter determines whether the specified directory can be shared between AWS accounts inside the same AWS organization (ORGANIZATIONS). It also determines whether you can share the directory with any other AWS account either inside or outside of the organization (HANDSHAKE).

The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer.

Class ShareDirectoryResponse

This is the response object from the ShareDirectory operation.

Class ShareLimitExceededException

DirectoryService exception

Class ShareTarget

Identifier that contains details about the directory consumer account.

Class Snapshot

Describes a directory snapshot.

Class SnapshotLimitExceededException

DirectoryService exception

Class SnapshotLimits

Contains manual snapshot limit information for a directory.

Class StartSchemaExtensionRequest

Container for the parameters to the StartSchemaExtension operation. Applies a schema extension to a Microsoft AD directory.

Class StartSchemaExtensionResponse

This is the response object from the StartSchemaExtension operation.

Class Tag

Metadata assigned to a directory consisting of a key-value pair.

Class TagLimitExceededException

DirectoryService exception

Class Trust

Describes a trust relationship between an AWS Managed Microsoft AD directory and an external domain.

Class UnshareDirectoryRequest

Container for the parameters to the UnshareDirectory operation. Stops the directory sharing between the directory owner and consumer accounts.

Class UnshareDirectoryResponse

This is the response object from the UnshareDirectory operation.

Class UnshareTarget

Identifier that contains details about the directory consumer account with whom the directory is being unshared.

Class UnsupportedOperationException

DirectoryService exception

Class UpdateConditionalForwarderRequest

Container for the parameters to the UpdateConditionalForwarder operation. Updates a conditional forwarder that has been set up for your AWS directory.

Class UpdateConditionalForwarderResponse

The result of an UpdateConditionalForwarder request.

Class UpdateNumberOfDomainControllersRequest

Container for the parameters to the UpdateNumberOfDomainControllers operation. Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.

Class UpdateNumberOfDomainControllersResponse

This is the response object from the UpdateNumberOfDomainControllers operation.

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 or Microsoft AD directory.

Class UpdateRadiusResponse

Contains the results of the UpdateRadius operation.

Class UpdateTrustRequest

Container for the parameters to the UpdateTrust operation. Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.

Class UpdateTrustResponse

This is the response object from the UpdateTrust operation.

Class UserDoesNotExistException

DirectoryService exception

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 AWS Managed Microsoft AD directory and an external domain.

Class VerifyTrustResponse

Result of a VerifyTrust request.