Skip to content

WorkDocs module#

Index > WorkDocs

Auto-generated documentation for WorkDocs type annotations stubs module mypy-boto3-workdocs.

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.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add WorkDocs 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 WorkDocs.

From PyPI with pip#

Install boto3-stubs for WorkDocs service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

WorkDocsClient#

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

# WorkDocsClient usage example

from boto3.session import Session

from mypy_boto3_workdocs.client import WorkDocsClient

def get_client() -> WorkDocsClient:
    return Session().client("workdocs")

Paginators#

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

# DescribeActivitiesPaginator usage example

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeActivitiesPaginator

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

Literals#

Type annotations for literals used in methods and schema.

# ActivityTypeType usage example

from mypy_boto3_workdocs.literals import ActivityTypeType

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

Type definitions#

Type annotations for type definitions used in methods and schema.