mypy-boto3-entityresolution Type Stubs for AWS Entity Resolution

Warnings

• breaking Support for Python 3.8 was removed in `mypy-boto3-builder` version 8.12.0 (and consequently in `mypy-boto3` packages). Users on Python 3.8 or older must upgrade to Python 3.9+.
  Fix: Upgrade your Python environment to version 3.9 or higher. (e.g., `python -m pip install --upgrade python` or use a newer Python interpreter).
• breaking The `mypy-boto3` ecosystem migrated to PEP 561 packages in `mypy-boto3-builder` version 8.12.0. This standardizes how type checkers like MyPy discover stubs, but may require updates to `mypy` configurations or ensure correct `py.typed` file discovery.
  Fix: Ensure your `mypy` setup is current and correctly configured to discover PEP 561 compliant stub packages. Typically, installing the package in the same environment as `mypy` should suffice.
• breaking TypeDef names for method arguments and conflicting names were refactored in `mypy-boto3-builder` version 8.9.0. For example, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`, and `Extra` postfixes moved to the end. This is a breaking change for code explicitly referencing these TypeDefs.
  Fix: Update imports and references to TypeDef names according to the new naming conventions. Refer to the specific service's documentation for exact new names.
• gotcha This package provides only type annotations. You must install `boto3` separately (e.g., `pip install boto3`) for your application to function at runtime. `mypy-boto3-entityresolution` is solely for static analysis.
  Fix: Always install `boto3` alongside `mypy-boto3-entityresolution` if you intend to run the code. `pip install mypy-boto3-entityresolution boto3` is the recommended approach.
• gotcha For full type-checking benefits and reliable IDE auto-completion, explicitly annotate your `boto3.client` calls with the specific client type (e.g., `client: EntityResolutionClient = boto3.client(...)`). While some IDEs might infer types, explicit annotations are often more robust.
  Fix: Add type hints to your `boto3.client` assignments, such as `client: EntityResolutionClient = boto3.client("entityresolution")`.

Install

• pip install mypy-boto3-entityresolution boto3 Install with pip

Imports

• EntityResolutionClient

  from mypy_boto3_entityresolution.client import EntityResolutionClient

• ListMatchingWorkflowsOutputTypeDef

  from mypy_boto3_entityresolution.type_defs import ListMatchingWorkflowsOutputTypeDef

Quickstart

This quickstart demonstrates how to initialize an AWS Entity Resolution client with explicit type annotations and list matching workflows. It highlights how type stubs enhance code completion and static analysis for `boto3` interactions. Ensure you have `boto3` installed and AWS credentials configured for actual execution.

import boto3
from mypy_boto3_entityresolution.client import EntityResolutionClient
from mypy_boto3_entityresolution.type_defs import ListMatchingWorkflowsOutputTypeDef
import os

def get_entity_resolution_workflows() -> list[ListMatchingWorkflowsOutputTypeDef]:
    # Ensure AWS credentials are configured (e.g., via environment variables, ~/.aws/credentials)
    # For local testing, you might need to mock or ensure a default region/profile
    client: EntityResolutionClient = boto3.client("entityresolution", region_name=os.environ.get('AWS_REGION', 'us-east-1'))

    # Example: List matching workflows
    response = client.list_matching_workflows(maxResults=10)
    print(f"Found {len(response['workflowSummaries'])} workflows.")
    # A mypy check would ensure 'workflowSummaries' exists and is correctly typed
    return response['workflowSummaries']

if __name__ == "__main__":
    # This code requires AWS credentials and a configured default region to run successfully.
    # Set AWS_REGION and AWS_ACCESS_KEY_ID/AWS_SECRET_ACCESS_KEY or use a configured profile.
    # Example: export AWS_REGION=us-east-1
    # Example: mypy your_script_name.py
    try:
        workflows = get_entity_resolution_workflows()
        for workflow in workflows:
            print(f"- Workflow ARN: {workflow['workflowArn']}")
    except Exception as e:
        print(f"Error: {e}. Please ensure AWS credentials and region are configured.")