Skip to content

DirectoryService module#

Index > DirectoryService

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

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.37.3' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add DirectoryService service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and DirectoryService.

From PyPI with pip#

Install types-boto3 for DirectoryService service.

# install with boto3 type annotations
python -m pip install 'types-boto3[ds]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[ds]'

# standalone installation
python -m pip install types-boto3-ds

How to uninstall#

python -m pip uninstall -y types-boto3-ds

Usage#

Code samples can be found in Examples.

DirectoryServiceClient#

Type annotations and code completion for boto3.client("ds") as DirectoryServiceClient boto3 documentation

# DirectoryServiceClient usage example

from boto3.session import Session

from types_boto3_ds.client import DirectoryServiceClient

def get_client() -> DirectoryServiceClient:
    return Session().client("ds")

Paginators#

Type annotations and code completion for paginators from boto3.client("ds").get_paginator("...").

# DescribeClientAuthenticationSettingsPaginator usage example

from boto3.session import Session

from types_boto3_ds.paginator import DescribeClientAuthenticationSettingsPaginator

def get_describe_client_authentication_settings_paginator() -> DescribeClientAuthenticationSettingsPaginator:
    return Session().client("ds").get_paginator("describe_client_authentication_settings"))

Literals#

Type annotations for literals used in methods and schema.

# CertificateStateType usage example

from types_boto3_ds.literals import CertificateStateType

def get_value() -> CertificateStateType:
    return "DeregisterFailed"

Type definitions#

Type annotations for type definitions used in methods and schema.