mypy-boto3-identitystore Type Annotations

1.42.20 · active · verified Sat Apr 11

mypy-boto3-identitystore provides type annotations for the boto3 IdentityStore service, currently at version 1.42.20. It is part of the larger `boto3-stubs` ecosystem, generated with `mypy-boto3-builder`. This active project releases frequently, often aligning with `boto3` and `botocore` updates, offering enhanced type checking capabilities for tools like MyPy and Pyright, and improved auto-completion in IDEs such as VSCode and PyCharm.

Warnings

breaking Removed support for Python 3.8. All `mypy-boto3` packages generated by `mypy-boto3-builder` version 8.12.0 and later (which includes this package version) no longer support Python 3.8.
Fix: Upgrade your Python environment to 3.9 or newer. The `requires_python` metadata is `^3.9`.
breaking Breaking changes to generated TypeDef names occurred in `mypy-boto3-builder` 8.9.0. If you explicitly import and use generated TypeDefs, their names might have changed (e.g., shorter names for packed method arguments, or `Extra` postfix moved).
Fix: Review your code for explicit `from mypy_boto3_identitystore.type_defs import ...` imports and update TypeDef names as per the `boto3-stubs` documentation for your specific service and version.
gotcha Version compatibility with `boto3`. `mypy-boto3-identitystore` versions are typically tied to specific `boto3` versions. Mismatching the stub package version with your installed `boto3` version can lead to incorrect type hints or missing attributes during type checking, even if the runtime code works.
Fix: Ensure that your `mypy-boto3-identitystore` version closely matches your installed `boto3` version. When installing `boto3-stubs` with extras, `pip install 'boto3-stubs[identitystore]'` typically handles this by installing compatible versions. If using standalone packages, manually ensure versions align.
gotcha This is a stub-only package (PEP 561). It provides type hints for `boto3` but contains no runtime code. Installing it without `boto3` (the actual AWS SDK) or a type checker will not provide any functional benefits or runtime changes.
Fix: Always install `boto3` (e.g., `pip install boto3`) alongside this stub package. To verify type checking, integrate a type checker like MyPy (`pip install mypy`) into your development workflow.
gotcha Explicit type annotations might be required for full IDE support, especially with `boto3-stubs-lite` or older PyCharm versions. While modern type checkers and IDEs often auto-discover types, some setups may require explicit `client: IdentityStoreClient = boto3.client(...)` annotations.
Fix: If you encounter incomplete type hinting, explicitly add type annotations to your `boto3.client()` calls, importing the client type (e.g., `from mypy_boto3_identitystore.client import IdentityStoreClient`).

Install

pip install mypy-boto3-identitystore Standalone installation
pip install 'boto3-stubs[identitystore]' Recommended (boto3-stubs with extras)

Imports

IdentityStoreClient
```
from mypy_boto3_identitystore.client import IdentityStoreClient
```
The Client type is provided by the stub package for explicit type hinting, not directly by boto3 at runtime. While runtime code uses `boto3.client('identitystore')`, type checkers need the explicit stub import for full functionality.

Quickstart

This quickstart demonstrates how to initialize a `boto3` IdentityStore client with explicit type annotations provided by `mypy-boto3-identitystore`. This enables your IDE and type checker (like MyPy) to provide accurate auto-completion and static analysis for all service-specific methods and parameters. Remember to have `boto3` installed and AWS credentials configured.

import boto3
from mypy_boto3_identitystore.client import IdentityStoreClient
from os import environ

# Configure AWS credentials and region (e.g., via environment variables or ~/.aws/credentials)
# For a runnable example, we'll use os.environ.get for safe execution.

# Explicitly type the client for mypy/IDE assistance
def get_identitystore_client() -> IdentityStoreClient:
    client: IdentityStoreClient = boto3.client(
        "identitystore",
        region_name=environ.get('AWS_REGION', 'us-east-1')
    )
    return client

# Example usage
if __name__ == "__main__":
    try:
        identitystore_client = get_identitystore_client()
        # Replace with a real IdentityStore ID from your AWS account
        identity_store_id = environ.get('IDENTITY_STORE_ID', 'd-xxxxxxxxxx')
        
        # Example: List users (requires appropriate permissions)
        # Note: This operation might require an actual IdentityStore ID to succeed.
        response = identitystore_client.list_users(IdentityStoreId=identity_store_id)
        print("Successfully listed IdentityStore users (first page).")
        for user in response.get('Users', []):
            print(f"  User ID: {user.get('UserId')}, UserName: {user.get('UserName')}")
        
        # Demonstrating a method that doesn't exist on BaseClient but does on IdentityStoreClient
        # This would be flagged by a type checker without the stub.
        # identitystore_client.non_existent_method() # Mypy error: "IdentityStoreClient" has no attribute "non_existent_method"

    except Exception as e:
        print(f"An error occurred: {e}")
        print("Please ensure 'boto3' is installed, AWS credentials are configured, and IDENTITY_STORE_ID is set if needed.")

view raw JSON →