mypy-boto3-datasync Type Stubs

1.42.85 · active · verified Sat Apr 11

mypy-boto3-datasync provides type annotations for `boto3`'s DataSync service client, enhancing static analysis with tools like MyPy. It ensures type safety for `boto3` calls, improving developer experience and catching potential errors pre-runtime. The library closely tracks `boto3` and AWS API releases, leading to frequent updates, currently at version 1.42.85.

Warnings

breaking Python 3.8 support has been removed. All `mypy-boto3` packages now require Python 3.9 or newer.
Fix: Upgrade your Python environment to 3.9 or higher. For Python 3.8, use `mypy-boto3` versions <8.12.0.
breaking Some generated `TypeDef` names were shortened (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`) and conflicting `TypeDef` postfixes were reordered. This can cause `mypy` errors if you explicitly imported these types.
Fix: Update your type import statements to reflect the new `TypeDef` names. Consult the generated stubs for the exact names if `mypy` reports an error.
gotcha All `mypy-boto3` packages, including `mypy-boto3-datasync`, migrated to PEP 561-compliant packages. While this improves standard stub discovery, older `mypy` configurations or custom stub paths might need adjustment to correctly locate the stubs.
Fix: Ensure `mypy` is up-to-date. If issues persist, verify `mypy`'s `MYPYPATH` or `pyproject.toml` settings are not conflicting with standard package discovery.
gotcha These packages provide type hints for static analysis only. They do not modify `boto3`'s runtime behavior or add any runtime type checking. Any runtime errors will still occur as per `boto3`'s behavior.
Fix: Understand that `mypy-boto3` is a development-time tool. Ensure robust error handling and validation for production `boto3` code.

Install

pip install mypy-boto3-datasync Install service-specific stubs
pip install boto3-stubs[datasync] Install as part of boto3-stubs (recommended)

Imports

DataSyncClient
```
from mypy_boto3_datasync.client import DataSyncClient
```
Client types are nested under the `.client` module.
ListTasksResponseTypeDef
```
from mypy_boto3_datasync.type_defs import ListTasksResponseTypeDef
```
Service-specific TypedDicts (request/response schemas) are in `.type_defs`.
ListTasksPaginator
```
from mypy_boto3_datasync.paginator import ListTasksPaginator
```
Paginator types are available in the `.paginator` module.

Quickstart

This example demonstrates how to import and apply type hints for the DataSync client and its response types. It initializes a `boto3` client and uses `mypy-boto3-datasync` stubs to enable static analysis for operations like `list_tasks`.

import boto3
from mypy_boto3_datasync.client import DataSyncClient
from mypy_boto3_datasync.type_defs import ListTasksResponseTypeDef

# Initialize a boto3 client with type hinting
# (Mypy may warn without # type: ignore, but it's correct for runtime use)
client: DataSyncClient = boto3.client("datasync", region_name="us-east-1")

try:
    # Use the client with type-safe operations
    response: ListTasksResponseTypeDef = client.list_tasks(MaxResults=5)
    print(f"Found {len(response.get('TaskList', []))} DataSync tasks.")
    for task in response.get('TaskList', []):
        print(f"  Task ARN: {task.get('TaskArn')}, Name: {task.get('Name')}")
except Exception as e:
    print(f"An error occurred: {e}")
    print("Ensure AWS credentials are configured (e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION environment variables or ~/.aws/credentials).")

view raw JSON →