Install & Compatibility
Where this runs
tested against v1.43.50 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.910 runs
installs and imports cleanly · install 0.0s · import 0.000s · 20.3MB
glibcpy 3.10–3.910 runs
installs and imports cleanly · install 3.4s · import 0.000s · 21MB
18MB installed
● package 18MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
OmicsClient
✓ from mypy_boto3_omics.client import OmicsClient
✗ from mypy_boto3_omics.client import OmicsClient
OmicsServiceClient
✓ from mypy_boto3_omics import OmicsServiceClient
✗ from mypy_boto3_omics.client import OmicsClient
This quickstart demonstrates how to use `mypy-boto3-omics` to add type hints to your `boto3` Omics client. It includes importing the `OmicsClient` type, initializing a type-hinted client, and making a sample API call. Remember to replace placeholder values like 'some-store-id' with actual values from your AWS environment. The `TYPE_CHECKING` guard ensures the stub package is only a development dependency.
import boto3
from typing import TYPE_CHECKING
# Recommended: Use TYPE_CHECKING guard to avoid runtime dependency on type stubs
if TYPE_CHECKING:
from mypy_boto3_omics import OmicsClient
from mypy_boto3_omics.type_defs import ListReferencesResponseTypeDef
def list_omics_references() -> None:
# Initialize the Omics client with type hints
omics_client: OmicsClient = boto3.client("omics")
print("Listing Omics references...")
try:
response: ListReferencesResponseTypeDef = omics_client.list_references(referenceStoreId="some-store-id") # Replace with a valid store ID
for ref in response.get("references", []):
print(f" - Reference: {ref.get('name')}, Status: {ref.get('status')}")
except omics_client.exceptions.ResourceNotFoundException:
print("Error: Reference store not found. Please provide a valid referenceStoreId.")
except Exception as e:
print(f"An unexpected error occurred: {e}")
if __name__ == "__main__":
# Ensure boto3 is installed (pip install boto3) and AWS credentials are configured
# For this example, 'some-store-id' needs to be a valid Omics Reference Store ID
# in your AWS account and region with appropriate permissions.
list_omics_references()
Debug
Known issues
breakingSupport for Python 3.8 was removed starting with `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 will need to upgrade their Python version to use recent versions of `mypy-boto3-omics`.fixUpgrade Python to 3.9 or newer.
affects: >=8.12.0 (builder version)
breakingTypeDef naming conventions changed in `mypy-boto3-builder` version 8.9.0. Some generated TypeDef names might have become shorter or had postfixes moved, potentially breaking code that explicitly referenced the old generated names (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`).fixUpdate explicit `TypeDef` references in your code to match the new generated names. Refer to the specific service's documentation or the `mypy_boto3_omics.type_defs` module for the correct names.
affects: >=8.9.0 (builder version)
gotchaThis package provides *only* type stubs. You must install `boto3` separately (e.g., `pip install boto3`) for your code to run. Without `boto3`, you will encounter runtime `ModuleNotFoundError` or similar issues.fixEnsure `boto3` is installed in your environment: `pip install boto3`.
affects: All
gotchaFor optimal performance and to avoid unnecessary runtime dependencies, it is recommended to wrap type stub imports within an `if TYPE_CHECKING:` block. This makes `mypy-boto3-omics` purely a development dependency.fixWrap type imports like `from mypy_boto3_omics import OmicsClient` inside `if TYPE_CHECKING:` blocks. When not type checking, define a dummy `object` type for these symbols.
affects: All
gotchaWhen using PyCharm, performance issues with `Literal` overloads have been reported (issue PY-40997). If you experience slowness, consider using `boto3-stubs-lite` (e.g., `pip install 'boto3-stubs-lite[omics]'`) or disabling PyCharm's internal type checker in favor of `mypy` or `pyright`.fixUse `boto3-stubs-lite` or configure PyCharm to use external type checkers like `mypy` or `pyright`.
affects: All, specifically with PyCharm
Upgrade
Version history
1.43.50latest on PyPI · released Jul 16, 2026
Audit
Dependencies
boto3requiredRuntime dependency for the AWS SDK functions that these stubs type-check. Must be installed separately.
mypyrequiredRequired for static type checking; this package provides the type definitions for mypy to consume.