DirectoryServiceData

Client

class DirectoryServiceData.Client

A low-level client representing AWS Directory Service Data

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.

Note

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.

import boto3

client = boto3.client('ds-data')

These are the available methods:

• add_group_member
• can_paginate
• close
• create_group
• create_user
• delete_group
• delete_user
• describe_group
• describe_user
• disable_user
• get_paginator
• get_waiter
• list_group_members
• list_groups
• list_groups_for_member
• list_users
• remove_group_member
• search_groups
• search_users
• update_group
• update_user

Paginators

Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.

The available paginators are:

• ListGroupMembers
• ListGroups
• ListGroupsForMember
• ListUsers
• SearchGroups
• SearchUsers