Getting Started¶

Installation¶

pip install capo-workdocs

Usage¶

from capo_workdocs import AsyncWorkDocsClient


async def main():
    async with AsyncWorkDocsClient() as work_docs:
        # Example: call the abort_document_version_upload operation
        response = await work_docs.abort_document_version_upload()
        print(response)

Pagination¶

Some operations in this SDK support pagination. If the operation supports pagination it will have an iter_ prefixed method that returns an async iterator.

from capo_workdocs import AsyncWorkDocsClient


async def main():
    async with AsyncWorkDocsClient() as work_docs:
        # Example: paginate over describe_activities
        async for item in work_docs.iter_describe_activities():
            print(item)

Error Handling¶

The SDK raises exceptions for errors returned by the API. Catch them to handle failures gracefully.

from capo_workdocs import AsyncWorkDocsClient
from capo_workdocs.error import ConcurrentModificationException


async def main():
    async with AsyncWorkDocsClient() as work_docs:
        try:
            await work_docs.abort_document_version_upload()
        except ConcurrentModificationException as e:
            print(f"Error: {e}")
            print(e.data)  # additional error data

Retrying¶

The SDK retries failed operations automatically. Retry behaviour follows the Smithy specification: errors are retried based on their is_retryable and is_throttling_error attributes. Throttling errors use a longer base delay. Network-level failures (connection errors and timeouts) are also retried. Non-retryable errors, such as client errors without the @retryable trait, are raised immediately without further attempts.

The number of attempts defaults to 3 and can be changed at the client level via retry_max_attempts, or per call via config_overrides.

from capo_workdocs import AsyncWorkDocsClient


async def main():
    async with AsyncWorkDocsClient() as work_docs:
        # Default: 3 attempts for every operation
        response = await work_docs.abort_document_version_upload()

        # Override per operation
        response = await work_docs.abort_document_version_upload(config_overrides={"retry_max_attempts": 5})

        # Disable retries for this call
        response = await work_docs.abort_document_version_upload(config_overrides={"retry_max_attempts": 1})