Skip to content

WorkDocs module#

Index > WorkDocs

Auto-generated documentation for WorkDocs type annotations stubs module types-aiobotocore-workdocs.

How to install#

From PyPI with pip#

Install types-aiobotocore for WorkDocs service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[workdocs]'


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


# standalone installation
python -m pip install types-aiobotocore-workdocs

How to uninstall#

python -m pip uninstall -y types-aiobotocore-workdocs

Usage#

Code samples can be found in Examples.

WorkDocsClient#

Type annotations and code completion for session.create_client("workdocs") as WorkDocsClient boto3 documentation

# WorkDocsClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_workdocs.client import WorkDocsClient


session = get_session()
async with session.create_client("workdocs") as client:
    client: WorkDocsClient

Paginators#

Type annotations and code completion for paginators from session.create_client("workdocs").get_paginator("...").

# DescribeActivitiesPaginator usage example

from types_aiobotocore_workdocs.paginator import DescribeActivitiesPaginator

def get_describe_activities_paginator() -> DescribeActivitiesPaginator:
    return client.get_paginator("describe_activities"))

Literals#

Type annotations for literals used in methods and schema.

# ActivityTypeType usage example

from types_aiobotocore_workdocs.literals import ActivityTypeType

def get_value() -> ActivityTypeType:
    return "DOCUMENT_ANNOTATION_ADDED"

Type definitions#

Type annotations for type definitions used in methods and schema.