AWS.DirectoryService
AWS Directory Service
This is the AWS Directory Service API Reference. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors.
Summary↑
| connect_directory(client, input, options \\ []) | Creates an AD Connector to connect an on-premises directory |
| create_alias(client, input, options \\ []) | 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 |
| create_computer(client, input, options \\ []) | Creates a computer account in the specified directory, and joins the computer to the directory |
| create_directory(client, input, options \\ []) | Creates a Simple AD directory |
| create_snapshot(client, input, options \\ []) | Creates a snapshot of an existing directory |
| delete_directory(client, input, options \\ []) | Deletes an AWS Directory Service directory |
| delete_snapshot(client, input, options \\ []) | Deletes a directory snapshot |
| describe_directories(client, input, options \\ []) | Obtains information about the directories that belong to this account |
| describe_snapshots(client, input, options \\ []) | Obtains information about the directory snapshots that belong to this account |
| disable_radius(client, input, options \\ []) | Disables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) for an AD Connector directory |
| disable_sso(client, input, options \\ []) | Disables single-sign on for a directory |
| enable_radius(client, input, options \\ []) | Enables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) for an AD Connector directory |
| enable_sso(client, input, options \\ []) | Enables single-sign on for a directory |
| get_directory_limits(client, input, options \\ []) | Obtains directory limit information for the current region |
| get_snapshot_limits(client, input, options \\ []) | Obtains the manual snapshot limits for a directory |
| restore_from_snapshot(client, input, options \\ []) | Restores a directory using an existing directory snapshot |
| update_radius(client, input, options \\ []) | Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory |
Functions
Creates an AD Connector to connect 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.
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
Creates a computer account in the specified directory, and joins the computer to the directory.
Creates a Simple AD directory.
Creates a snapshot of an existing directory.
You cannot take snapshots of extended or connected directories.
Deletes an AWS Directory Service directory.
Deletes a directory snapshot.
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 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.
Disables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) for an AD Connector directory.
Disables single-sign on for a directory.
Enables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) 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.
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.
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.