Skip to content

Examples#

Index > DirectoryService > Examples

Auto-generated documentation for DirectoryService type annotations stubs module types-aiobotocore-ds.

Client#

Implicit type annotations#

Can be used with types-aioboto3[ds] package installed.

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

# DirectoryServiceClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("ds") as client:  # (1)
    result = await client.accept_shared_directory()  # (2)
  1. client: DirectoryServiceClient
  2. result: AcceptSharedDirectoryResultTypeDef
# DescribeClientAuthenticationSettingsPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("ds") as client:  # (1)
    paginator = client.get_paginator("describe_client_authentication_settings")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: DirectoryServiceClient
  2. paginator: DescribeClientAuthenticationSettingsPaginator
  3. item: DescribeClientAuthenticationSettingsResultTypeDef

Explicit type annotations#

With types-aioboto3-lite[ds] or a standalone types_aiobotocore_ds package, you have to explicitly specify client: DirectoryServiceClient 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.

# DirectoryServiceClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_ds.client import DirectoryServiceClient
from types_aiobotocore_ds.type_defs import AcceptSharedDirectoryResultTypeDef
from types_aiobotocore_ds.type_defs import AcceptSharedDirectoryRequestRequestTypeDef


session = Session()

client: DirectoryServiceClient
async with session.client("ds") as client:  # (1)
    kwargs: AcceptSharedDirectoryRequestRequestTypeDef = {...}  # (2)
    result: AcceptSharedDirectoryResultTypeDef = await client.accept_shared_directory(**kwargs)  # (3)
  1. client: DirectoryServiceClient
  2. kwargs: AcceptSharedDirectoryRequestRequestTypeDef
  3. result: AcceptSharedDirectoryResultTypeDef
# DescribeClientAuthenticationSettingsPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_ds.client import DirectoryServiceClient
from types_aiobotocore_ds.paginator import DescribeClientAuthenticationSettingsPaginator
from types_aiobotocore_ds.type_defs import DescribeClientAuthenticationSettingsResultTypeDef


session = Session()

client: DirectoryServiceClient
async with session.client("ds") as client:  # (1)
    paginator: DescribeClientAuthenticationSettingsPaginator = client.get_paginator("describe_client_authentication_settings")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeClientAuthenticationSettingsResultTypeDef
        print(item)  # (3)
  1. client: DirectoryServiceClient
  2. paginator: DescribeClientAuthenticationSettingsPaginator
  3. item: DescribeClientAuthenticationSettingsResultTypeDef