Skip to content

DirectoryServiceDataClient#

Index > DirectoryServiceData > DirectoryServiceDataClient

Auto-generated documentation for DirectoryServiceData type annotations stubs module types-boto3-ds-data.

DirectoryServiceDataClient#

Type annotations and code completion for boto3.client("ds-data"). boto3 documentation

# DirectoryServiceDataClient usage example

from boto3.session import Session
from types_boto3_ds_data.client import DirectoryServiceDataClient

def get_ds-data_client() -> DirectoryServiceDataClient:
    return Session().client("ds-data")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("ds-data").exceptions structure.

# Exceptions.exceptions usage example

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

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.DirectoryUnavailableException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_ds_data.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("ds-data").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("ds-data").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

add_group_member#

Adds an existing user, group, or computer as a group member.

Type annotations and code completion for boto3.client("ds-data").add_group_member method. boto3 documentation

# add_group_member method definition

def add_group_member(
    self,
    *,
    DirectoryId: str,
    GroupName: str,
    MemberName: str,
    ClientToken: str = ...,
    MemberRealm: str = ...,
) -> dict[str, Any]:
    ...
# add_group_member method usage example with argument unpacking

kwargs: AddGroupMemberRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "GroupName": ...,
    "MemberName": ...,
}

parent.add_group_member(**kwargs)
  1. See AddGroupMemberRequestRequestTypeDef

create_group#

Creates a new group.

Type annotations and code completion for boto3.client("ds-data").create_group method. boto3 documentation

# create_group method definition

def create_group(
    self,
    *,
    DirectoryId: str,
    SAMAccountName: str,
    ClientToken: str = ...,
    GroupScope: GroupScopeType = ...,  # (1)
    GroupType: GroupTypeType = ...,  # (2)
    OtherAttributes: Mapping[str, AttributeValueUnionTypeDef] = ...,  # (3)
) -> CreateGroupResultTypeDef:  # (4)
    ...
  1. See GroupScopeType
  2. See GroupTypeType
  3. See AttributeValueTypeDef AttributeValueOutputTypeDef
  4. See CreateGroupResultTypeDef 
# create_group method usage example with argument unpacking

kwargs: CreateGroupRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SAMAccountName": ...,
}

parent.create_group(**kwargs)
  1. See CreateGroupRequestRequestTypeDef

create_user#

Creates a new user.

Type annotations and code completion for boto3.client("ds-data").create_user method. boto3 documentation

# create_user method definition

def create_user(
    self,
    *,
    DirectoryId: str,
    SAMAccountName: str,
    ClientToken: str = ...,
    EmailAddress: str = ...,
    GivenName: str = ...,
    OtherAttributes: Mapping[str, AttributeValueTypeDef] = ...,  # (1)
    Surname: str = ...,
) -> CreateUserResultTypeDef:  # (2)
    ...
  1. See AttributeValueTypeDef
  2. See CreateUserResultTypeDef 
# create_user method usage example with argument unpacking

kwargs: CreateUserRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SAMAccountName": ...,
}

parent.create_user(**kwargs)
  1. See CreateUserRequestRequestTypeDef

delete_group#

Deletes a group.

Type annotations and code completion for boto3.client("ds-data").delete_group method. boto3 documentation

# delete_group method definition

def delete_group(
    self,
    *,
    DirectoryId: str,
    SAMAccountName: str,
    ClientToken: str = ...,
) -> dict[str, Any]:
    ...
# delete_group method usage example with argument unpacking

kwargs: DeleteGroupRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SAMAccountName": ...,
}

parent.delete_group(**kwargs)
  1. See DeleteGroupRequestRequestTypeDef

delete_user#

Deletes a user.

Type annotations and code completion for boto3.client("ds-data").delete_user method. boto3 documentation

# delete_user method definition

def delete_user(
    self,
    *,
    DirectoryId: str,
    SAMAccountName: str,
    ClientToken: str = ...,
) -> dict[str, Any]:
    ...
# delete_user method usage example with argument unpacking

kwargs: DeleteUserRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SAMAccountName": ...,
}

parent.delete_user(**kwargs)
  1. See DeleteUserRequestRequestTypeDef

describe_group#

Returns information about a specific group.

Type annotations and code completion for boto3.client("ds-data").describe_group method. boto3 documentation

# describe_group method definition

def describe_group(
    self,
    *,
    DirectoryId: str,
    SAMAccountName: str,
    OtherAttributes: Sequence[str] = ...,
    Realm: str = ...,
) -> DescribeGroupResultTypeDef:  # (1)
    ...
  1. See DescribeGroupResultTypeDef 
# describe_group method usage example with argument unpacking

kwargs: DescribeGroupRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SAMAccountName": ...,
}

parent.describe_group(**kwargs)
  1. See DescribeGroupRequestRequestTypeDef

describe_user#

Returns information about a specific user.

Type annotations and code completion for boto3.client("ds-data").describe_user method. boto3 documentation

# describe_user method definition

def describe_user(
    self,
    *,
    DirectoryId: str,
    SAMAccountName: str,
    OtherAttributes: Sequence[str] = ...,
    Realm: str = ...,
) -> DescribeUserResultTypeDef:  # (1)
    ...
  1. See DescribeUserResultTypeDef 
# describe_user method usage example with argument unpacking

kwargs: DescribeUserRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SAMAccountName": ...,
}

parent.describe_user(**kwargs)
  1. See DescribeUserRequestRequestTypeDef

disable_user#

Deactivates an active user account.

Type annotations and code completion for boto3.client("ds-data").disable_user method. boto3 documentation

# disable_user method definition

def disable_user(
    self,
    *,
    DirectoryId: str,
    SAMAccountName: str,
    ClientToken: str = ...,
) -> dict[str, Any]:
    ...
# disable_user method usage example with argument unpacking

kwargs: DisableUserRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SAMAccountName": ...,
}

parent.disable_user(**kwargs)
  1. See DisableUserRequestRequestTypeDef

list_group_members#

Returns member information for the specified group.

Type annotations and code completion for boto3.client("ds-data").list_group_members method. boto3 documentation

# list_group_members method definition

def list_group_members(
    self,
    *,
    DirectoryId: str,
    SAMAccountName: str,
    MaxResults: int = ...,
    MemberRealm: str = ...,
    NextToken: str = ...,
    Realm: str = ...,
) -> ListGroupMembersResultTypeDef:  # (1)
    ...
  1. See ListGroupMembersResultTypeDef 
# list_group_members method usage example with argument unpacking

kwargs: ListGroupMembersRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SAMAccountName": ...,
}

parent.list_group_members(**kwargs)
  1. See ListGroupMembersRequestRequestTypeDef

list_groups#

Returns group information for the specified directory.

Type annotations and code completion for boto3.client("ds-data").list_groups method. boto3 documentation

# list_groups method definition

def list_groups(
    self,
    *,
    DirectoryId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Realm: str = ...,
) -> ListGroupsResultTypeDef:  # (1)
    ...
  1. See ListGroupsResultTypeDef 
# list_groups method usage example with argument unpacking

kwargs: ListGroupsRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.list_groups(**kwargs)
  1. See ListGroupsRequestRequestTypeDef

list_groups_for_member#

Returns group information for the specified member.

Type annotations and code completion for boto3.client("ds-data").list_groups_for_member method. boto3 documentation

# list_groups_for_member method definition

def list_groups_for_member(
    self,
    *,
    DirectoryId: str,
    SAMAccountName: str,
    MaxResults: int = ...,
    MemberRealm: str = ...,
    NextToken: str = ...,
    Realm: str = ...,
) -> ListGroupsForMemberResultTypeDef:  # (1)
    ...
  1. See ListGroupsForMemberResultTypeDef 
# list_groups_for_member method usage example with argument unpacking

kwargs: ListGroupsForMemberRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SAMAccountName": ...,
}

parent.list_groups_for_member(**kwargs)
  1. See ListGroupsForMemberRequestRequestTypeDef

list_users#

Returns user information for the specified directory.

Type annotations and code completion for boto3.client("ds-data").list_users method. boto3 documentation

# list_users method definition

def list_users(
    self,
    *,
    DirectoryId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Realm: str = ...,
) -> ListUsersResultTypeDef:  # (1)
    ...
  1. See ListUsersResultTypeDef 
# list_users method usage example with argument unpacking

kwargs: ListUsersRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.list_users(**kwargs)
  1. See ListUsersRequestRequestTypeDef

remove_group_member#

Removes a member from a group.

Type annotations and code completion for boto3.client("ds-data").remove_group_member method. boto3 documentation

# remove_group_member method definition

def remove_group_member(
    self,
    *,
    DirectoryId: str,
    GroupName: str,
    MemberName: str,
    ClientToken: str = ...,
    MemberRealm: str = ...,
) -> dict[str, Any]:
    ...
# remove_group_member method usage example with argument unpacking

kwargs: RemoveGroupMemberRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "GroupName": ...,
    "MemberName": ...,
}

parent.remove_group_member(**kwargs)
  1. See RemoveGroupMemberRequestRequestTypeDef

search_groups#

Searches the specified directory for a group.

Type annotations and code completion for boto3.client("ds-data").search_groups method. boto3 documentation

# search_groups method definition

def search_groups(
    self,
    *,
    DirectoryId: str,
    SearchAttributes: Sequence[str],
    SearchString: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Realm: str = ...,
) -> SearchGroupsResultTypeDef:  # (1)
    ...
  1. See SearchGroupsResultTypeDef 
# search_groups method usage example with argument unpacking

kwargs: SearchGroupsRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SearchAttributes": ...,
    "SearchString": ...,
}

parent.search_groups(**kwargs)
  1. See SearchGroupsRequestRequestTypeDef

search_users#

Searches the specified directory for a user.

Type annotations and code completion for boto3.client("ds-data").search_users method. boto3 documentation

# search_users method definition

def search_users(
    self,
    *,
    DirectoryId: str,
    SearchAttributes: Sequence[str],
    SearchString: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Realm: str = ...,
) -> SearchUsersResultTypeDef:  # (1)
    ...
  1. See SearchUsersResultTypeDef 
# search_users method usage example with argument unpacking

kwargs: SearchUsersRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SearchAttributes": ...,
    "SearchString": ...,
}

parent.search_users(**kwargs)
  1. See SearchUsersRequestRequestTypeDef

update_group#

Updates group information.

Type annotations and code completion for boto3.client("ds-data").update_group method. boto3 documentation

# update_group method definition

def update_group(
    self,
    *,
    DirectoryId: str,
    SAMAccountName: str,
    ClientToken: str = ...,
    GroupScope: GroupScopeType = ...,  # (1)
    GroupType: GroupTypeType = ...,  # (2)
    OtherAttributes: Mapping[str, AttributeValueTypeDef] = ...,  # (3)
    UpdateType: UpdateTypeType = ...,  # (4)
) -> dict[str, Any]:
    ...
  1. See GroupScopeType
  2. See GroupTypeType
  3. See AttributeValueTypeDef
  4. See UpdateTypeType 
# update_group method usage example with argument unpacking

kwargs: UpdateGroupRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SAMAccountName": ...,
}

parent.update_group(**kwargs)
  1. See UpdateGroupRequestRequestTypeDef

update_user#

Updates user information.

Type annotations and code completion for boto3.client("ds-data").update_user method. boto3 documentation

# update_user method definition

def update_user(
    self,
    *,
    DirectoryId: str,
    SAMAccountName: str,
    ClientToken: str = ...,
    EmailAddress: str = ...,
    GivenName: str = ...,
    OtherAttributes: Mapping[str, AttributeValueTypeDef] = ...,  # (1)
    Surname: str = ...,
    UpdateType: UpdateTypeType = ...,  # (2)
) -> dict[str, Any]:
    ...
  1. See AttributeValueTypeDef
  2. See UpdateTypeType 
# update_user method usage example with argument unpacking

kwargs: UpdateUserRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SAMAccountName": ...,
}

parent.update_user(**kwargs)
  1. See UpdateUserRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("ds-data").get_paginator method with overloads.