View Source AWS.DirectoryServiceData (aws-elixir v1.0.4)
Amazon Web Services Directory Service Data is an extension of Directory Service.
This API reference provides detailed information about Directory Service Data operations and object types.
With Directory Service Data, you can create, read, update, and delete users,
groups, and memberships from
your Managed Microsoft AD without additional costs and without deploying
dedicated management
instances. You can also perform built-in object management tasks across
directories without
direct network connectivity, which simplifies provisioning and access management
to achieve
fully automated deployments. Directory Service Data supports user and group
write operations, such as
CreateUser and CreateGroup, within the organizational unit (OU) of
your Managed Microsoft AD. Directory Service Data supports read operations, such
as ListUsers and
ListGroups, on all users, groups, and group memberships within your
Managed Microsoft AD and across trusted realms. Directory Service Data supports
adding and removing group members in
your OU and the Amazon Web Services Delegated Groups OU, so you can grant and
deny access to specific roles
and permissions. For more information, see Manage users and groups
in the Directory Service Administration Guide.
Directory management operations and configuration changes made against the Directory Service API will also reflect in Directory Service Data API with eventual consistency. You can expect a short delay between management changes, such as adding a new directory trust and calling the Directory Service Data API for the newly created trusted realm.
Directory Service Data connects to your Managed Microsoft AD domain controllers and performs operations on underlying directory objects. When you create your Managed Microsoft AD, you choose subnets for domain controllers that Directory Service creates on your behalf. If a domain controller is unavailable, Directory Service Data uses an available domain controller. As a result, you might notice eventual consistency while objects replicate from one domain controller to another domain controller. For more information, see What gets created in the Directory Service Administration Guide. Directory limits vary by Managed Microsoft AD edition:
*
Standard edition – Supports 8 transactions per second (TPS) for read operations and 4 TPS for write operations per directory. There's a concurrency limit of 10 concurrent requests.
*
Enterprise edition – Supports 16 transactions per second (TPS) for read operations and 8 TPS for write operations per directory. There's a concurrency limit of 10 concurrent requests.
*
Amazon Web Services Account - Supports a total of 100 TPS for Directory Service Data operations across all directories.
Directory Service Data only supports the Managed Microsoft AD directory type and is only available in the primary Amazon Web Services Region. For more information, see Managed Microsoft AD and Primary vs additional Regions in the Directory Service Administration Guide.
Link to this section Summary
Functions
Adds an existing user, group, or computer as a group member.
Creates a new group.
Creates a new user.
Deletes a group.
Deletes a user.
Returns information about a specific group.
Returns information about a specific user.
Deactivates an active user account.
Returns member information for the specified group.
Returns group information for the specified directory.
Returns group information for the specified member.
Returns user information for the specified directory.
Removes a member from a group.
Searches the specified directory for a group.
Searches the specified directory for a user.
Updates group information.
Updates user information.
Link to this section Functions
Adds an existing user, group, or computer as a group member.
Creates a new group.
Creates a new user.
Deletes a group.
Deletes a user.
Returns information about a specific group.
Returns information about a specific user.
Deactivates an active user account.
For information about how to enable an inactive user account, see ResetUserPassword in the Directory Service API Reference.
Returns member information for the specified group.
This operation supports pagination with the use of the NextToken request and
response parameters. If more results are available, the
ListGroupMembers.NextToken member contains a token that you pass in the next
call to ListGroupMembers. This retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults
parameter.
Returns group information for the specified directory.
This operation supports pagination with the use of the NextToken request and
response parameters. If more results are available, the ListGroups.NextToken
member contains a token that you pass in the next call to ListGroups. This
retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults
parameter.
Returns group information for the specified member.
This operation supports pagination with the use of the NextToken request and
response parameters. If more results are available, the
ListGroupsForMember.NextToken member contains a token that you pass in the
next
call to ListGroupsForMember. This retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults
parameter.
Returns user information for the specified directory.
This operation supports pagination with the use of the NextToken request and
response parameters. If more results are available, the ListUsers.NextToken
member contains a token that you pass in the next call to ListUsers. This
retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults
parameter.
Removes a member from a group.
Searches the specified directory for a group.
You can find groups that match the
SearchString parameter with the value of their attributes included in the
SearchString parameter.
This operation supports pagination with the use of the NextToken request and
response parameters. If more results are available, the SearchGroups.NextToken
member contains a token that you pass in the next call to SearchGroups. This
retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults
parameter.
Searches the specified directory for a user.
You can find users that match the
SearchString parameter with the value of their attributes included in the
SearchString parameter.
This operation supports pagination with the use of the NextToken request and
response parameters. If more results are available, the SearchUsers.NextToken
member contains a token that you pass in the next call to SearchUsers. This
retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults
parameter.
Updates group information.
Updates user information.