Skip to content

Examples#

Index > DirectoryServiceData > Examples

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

Client#

Implicit type annotations#

Can be used with boto3-stubs[ds-data] package installed.

Write your DirectoryServiceData code as usual, type checking and code completion should work out of the box.

# DirectoryServiceDataClient usage example

from boto3.session import Session


session = Session()

client = session.client("ds-data")  # (1)
result = client.create_group()  # (2)
  1. client: DirectoryServiceDataClient
  2. result: CreateGroupResultTypeDef
# ListGroupMembersPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("ds-data")  # (1)

paginator = client.get_paginator("list_group_members")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DirectoryServiceDataClient
  2. paginator: ListGroupMembersPaginator
  3. item: ListGroupMembersResultTypeDef

Explicit type annotations#

With boto3-stubs-lite[ds-data] or a standalone mypy_boto3_ds_data package, you have to explicitly specify client: DirectoryServiceDataClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# DirectoryServiceDataClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_ds_data.client import DirectoryServiceDataClient
from mypy_boto3_ds_data.type_defs import CreateGroupResultTypeDef
from mypy_boto3_ds_data.type_defs import CreateGroupRequestRequestTypeDef


session = Session()

client: DirectoryServiceDataClient = session.client("ds-data")

kwargs: CreateGroupRequestRequestTypeDef = {...}
result: CreateGroupResultTypeDef = client.create_group(**kwargs)
# ListGroupMembersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_ds_data.client import DirectoryServiceDataClient
from mypy_boto3_ds_data.paginator import ListGroupMembersPaginator
from mypy_boto3_ds_data.type_defs import ListGroupMembersResultTypeDef


session = Session()
client: DirectoryServiceDataClient = session.client("ds-data")

paginator: ListGroupMembersPaginator = client.get_paginator("list_group_members")
for item in paginator.paginate(...):
    item: ListGroupMembersResultTypeDef
    print(item)