Skip to content

DirectoryService module#

Index > DirectoryService

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

How to install#

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 boto3-stubs for DirectoryService service.

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


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


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

How to uninstall#

python -m pip uninstall -y mypy-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 mypy_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 mypy_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 schemas.

# CertificateStateType usage example

from mypy_boto3_ds.literals import CertificateStateType

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

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AcceptSharedDirectoryRequestRequestTypeDef usage example

from mypy_boto3_ds.type_defs import AcceptSharedDirectoryRequestRequestTypeDef

def get_value() -> AcceptSharedDirectoryRequestRequestTypeDef:
    return {
        "SharedDirectoryId": ...,
    }