AWS.DirectoryService — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptSharedDirectory(params = {}, callback) ⇒ AWS.Request

Accepts a directory sharing request that was sent from the directory owner account.

addIpRoutes(params = {}, callback) ⇒ AWS.Request

If 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 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 Amazon Web Services 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 Directory Service API Permissions: Actions, Resources, and Conditions Reference.

addRegion(params = {}, callback) ⇒ AWS.Request

Adds two domain controllers in the specified Region for the specified directory.

addTagsToResource(params = {}, callback) ⇒ AWS.Request

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.

cancelSchemaExtension(params = {}, callback) ⇒ AWS.Request

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.

connectDirectory(params = {}, callback) ⇒ AWS.Request

createAlias(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Creates an Active Directory computer object in the specified directory.

createConditionalForwarder(params = {}, callback) ⇒ AWS.Request

Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

createDirectory(params = {}, callback) ⇒ AWS.Request

createLogSubscription(params = {}, callback) ⇒ AWS.Request

Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.

createMicrosoftAD(params = {}, callback) ⇒ AWS.Request

createSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.

Note: You cannot take snapshots of AD Connector directories.

createTrust(params = {}, callback) ⇒ AWS.Request

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed 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 Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.

deleteConditionalForwarder(params = {}, callback) ⇒ AWS.Request

Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.

deleteDirectory(params = {}, callback) ⇒ AWS.Request

deleteLogSubscription(params = {}, callback) ⇒ AWS.Request

Deletes the specified log subscription.

deleteSnapshot(params = {}, callback) ⇒ AWS.Request

Deletes a directory snapshot.

deleteTrust(params = {}, callback) ⇒ AWS.Request

Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.

deregisterCertificate(params = {}, callback) ⇒ AWS.Request

Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.

deregisterEventTopic(params = {}, callback) ⇒ AWS.Request

Removes the specified directory as a publisher to the specified Amazon SNS topic.

describeCertificate(params = {}, callback) ⇒ AWS.Request

Displays information about the certificate registered for secure LDAP or client certificate authentication.

describeClientAuthenticationSettings(params = {}, callback) ⇒ AWS.Request

Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.

describeConditionalForwarders(params = {}, callback) ⇒ AWS.Request

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.

describeDirectories(params = {}, callback) ⇒ AWS.Request

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.

describeDomainControllers(params = {}, callback) ⇒ AWS.Request

Provides information about any domain controllers in your directory.

describeEventTopics(params = {}, callback) ⇒ AWS.Request

Obtains information about which Amazon 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.

describeLDAPSSettings(params = {}, callback) ⇒ AWS.Request

Describes the status of LDAP security for the specified directory.

describeRegions(params = {}, callback) ⇒ AWS.Request

Provides information about the Regions that are configured for multi-Region replication.

describeSettings(params = {}, callback) ⇒ AWS.Request

Retrieves information about the configurable settings for the specified directory.

describeSharedDirectories(params = {}, callback) ⇒ AWS.Request

Returns the shared directories in your account.

describeSnapshots(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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.

describeUpdateDirectory(params = {}, callback) ⇒ AWS.Request

Describes the updates of a directory for a particular update type.

disableClientAuthentication(params = {}, callback) ⇒ AWS.Request

Disables alternative client authentication methods for the specified directory.

disableLDAPS(params = {}, callback) ⇒ AWS.Request

Deactivates LDAP secure calls for the specified directory.

disableRadius(params = {}, callback) ⇒ AWS.Request

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

disableSso(params = {}, callback) ⇒ AWS.Request

Disables single-sign on for a directory.

enableClientAuthentication(params = {}, callback) ⇒ AWS.Request

Enables alternative client authentication methods for the specified directory.

enableLDAPS(params = {}, callback) ⇒ AWS.Request

Activates the switch for the specific directory to always use LDAP secure calls.

enableRadius(params = {}, callback) ⇒ AWS.Request

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

enableSso(params = {}, callback) ⇒ AWS.Request

Enables 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 the directory without having to enter their credentials separately.

getDirectoryLimits(params = {}, callback) ⇒ AWS.Request

Obtains directory limit information for the current Region.

getSnapshotLimits(params = {}, callback) ⇒ AWS.Request

Obtains the manual snapshot limits for a directory.

listCertificates(params = {}, callback) ⇒ AWS.Request

For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.

listIpRoutes(params = {}, callback) ⇒ AWS.Request

Lists the address blocks that you have added to a directory.

listLogSubscriptions(params = {}, callback) ⇒ AWS.Request

Lists the active log subscriptions for the Amazon Web Services account.

listSchemaExtensions(params = {}, callback) ⇒ AWS.Request

Lists all schema extensions applied to a Microsoft AD Directory.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags on a directory.

registerCertificate(params = {}, callback) ⇒ AWS.Request

Registers a certificate for a secure LDAP or client certificate authentication.

registerEventTopic(params = {}, callback) ⇒ AWS.Request

Associates 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 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.

rejectSharedDirectory(params = {}, callback) ⇒ AWS.Request

Rejects a directory sharing request that was sent from the directory owner account.

removeIpRoutes(params = {}, callback) ⇒ AWS.Request

Removes IP address blocks from a directory.

removeRegion(params = {}, callback) ⇒ AWS.Request

Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the DeleteDirectory API.

removeTagsFromResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a directory.

resetUserPassword(params = {}, callback) ⇒ AWS.Request

Resets the password for any user in your Managed Microsoft AD or Simple AD directory.

You can reset the password for any user in your directory with the following exceptions:

• For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.
• For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.

restoreFromSnapshot(params = {}, callback) ⇒ AWS.Request

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.

shareDirectory(params = {}, callback) ⇒ AWS.Request

Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer). With this operation you can use your directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.

When you share your Managed Microsoft AD directory, 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 Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also determines whether you can share the directory with any other Amazon Web Services 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.

startSchemaExtension(params = {}, callback) ⇒ AWS.Request

Applies a schema extension to a Microsoft AD directory.

unshareDirectory(params = {}, callback) ⇒ AWS.Request

Stops the directory sharing between the directory owner and consumer accounts.

updateConditionalForwarder(params = {}, callback) ⇒ AWS.Request

Updates a conditional forwarder that has been set up for your Amazon Web Services directory.

updateDirectorySetup(params = {}, callback) ⇒ AWS.Request

Updates the directory for a particular update type.

updateNumberOfDomainControllers(params = {}, callback) ⇒ AWS.Request

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.

updateRadius(params = {}, callback) ⇒ AWS.Request

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.

updateSettings(params = {}, callback) ⇒ AWS.Request

Updates the configurable settings for the specified directory.

updateTrust(params = {}, callback) ⇒ AWS.Request

Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.

verifyTrust(params = {}, callback) ⇒ AWS.Request

Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.