Skip to content

CloudDirectory module#

Index > CloudDirectory

Auto-generated documentation for CloudDirectory type annotations stubs module mypy-boto3-clouddirectory.

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 CloudDirectory.

From PyPI with pip#

Install boto3-stubs for CloudDirectory service.

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


# 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[clouddirectory]'


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

How to uninstall#

python -m pip uninstall -y mypy-boto3-clouddirectory

Usage#

Code samples can be found in Examples.

CloudDirectoryClient#

Type annotations and code completion for boto3.client("clouddirectory") as CloudDirectoryClient boto3 documentation

# CloudDirectoryClient usage example

from boto3.session import Session

from mypy_boto3_clouddirectory.client import CloudDirectoryClient

def get_client() -> CloudDirectoryClient:
    return Session().client("clouddirectory")

Paginators#

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

# ListAppliedSchemaArnsPaginator usage example

from boto3.session import Session

from mypy_boto3_clouddirectory.paginator import ListAppliedSchemaArnsPaginator

def get_list_applied_schema_arns_paginator() -> ListAppliedSchemaArnsPaginator:
    return Session().client("clouddirectory").get_paginator("list_applied_schema_arns"))

Literals#

Type annotations for literals used in methods and schemas.

# BatchReadExceptionTypeType usage example

from mypy_boto3_clouddirectory.literals import BatchReadExceptionTypeType

def get_value() -> BatchReadExceptionTypeType:
    return "AccessDeniedException"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ObjectReferenceTypeDef usage example

from mypy_boto3_clouddirectory.type_defs import ObjectReferenceTypeDef

def get_value() -> ObjectReferenceTypeDef:
    return {
        "Selector": ...,
    }