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-aioboto3 for WorkDocs service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[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-aioboto3-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.client("workdocs") as WorkDocsClient boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_workdocs.client import WorkDocsClient


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

Paginators

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

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.

Usage example
from types_aiobotocore_workdocs.literals import ActivityTypeType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from types_aiobotocore_workdocs.type_defs import AbortDocumentVersionUploadRequestRequestTypeDef

def get_value() -> AbortDocumentVersionUploadRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
    }