aws-elixir v0.4.0 AWS.DirectoryService
AWS Directory Service
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.
Summary
Functions
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
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
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
Creates an AD Connector to connect to an on-premises directory
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
Creates a computer account in the specified directory, and joins the computer to the directory
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
Creates a Simple AD directory
Creates a Microsoft AD in the AWS cloud
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud
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
Deletes a conditional forwarder that has been set up for your AWS directory
Deletes an AWS Directory Service directory
Deletes a directory snapshot
Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain
Removes the specified directory as a publisher to the specified SNS topic
Obtains information about the conditional forwarders for this account
Obtains information about the directories that belong to this account
Obtains information about which SNS topics receive status messages from the specified directory
Obtains information about the directory snapshots that belong to this account
Obtains information about the trust relationships for this account
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory
Disables single-sign on for a directory
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory
Enables single sign-on for a directory
Obtains directory limit information for the current region
Obtains the manual snapshot limits for a directory
Lists the address blocks that you have added to a directory
Lists all schema extensions applied to a Microsoft AD Directory
Lists all tags on a directory
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
Removes IP address blocks from a directory
Removes tags from a directory
Restores a directory using an existing directory snapshot
Applies a schema extension to a Microsoft AD directory
Updates a conditional forwarder that has been set up for your AWS directory
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory
AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships
Functions
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.
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.
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
.
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.
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
.
Creates a computer account in the specified directory, and joins the computer to the directory.
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.
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.
Creates a Microsoft AD in the AWS cloud.
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.
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
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.
Deletes a conditional forwarder that has been set up for your AWS directory.
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.
Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
Removes the specified directory as a publisher to the specified SNS topic.
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.
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.
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.
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.
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.
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
Obtains directory limit information for the current region.
Obtains the manual snapshot limits for a directory.
Lists the address blocks that you have added to a directory.
Lists all schema extensions applied to a Microsoft AD Directory.
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.
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.
Applies a schema extension to a Microsoft AD directory.
Updates a conditional forwarder that has been set up for your AWS directory.
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.