mypy-boto3 Marketplace Entitlement Type Stubs

Warnings

• breaking Python 3.8 support was removed for `mypy-boto3` packages (including this one) starting with `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 will experience build failures or missing type information.
  Fix: Upgrade your Python environment to 3.9 or newer. If stuck on Python 3.8, you might need to pin to an older `mypy-boto3-marketplace-entitlement` version (e.g., <1.42.58) if available, but this is not officially supported.
• breaking The `mypy-boto3` packages migrated to PEP 561 packaging (namespace packages) with `mypy-boto3-builder` version 8.12.0. This changes how type checkers discover packages, potentially causing issues in complex environments or older `mypy` versions.
  Fix: Ensure your `mypy` version is up-to-date. If issues persist, verify `mypy`'s `PYTHONPATH` or `MYPYPATH` is correctly configured to locate type stubs within your environment.
• breaking Type definition names for packed method arguments were shortened or adjusted to resolve conflicts starting with `mypy-boto3-builder` version 8.9.0. For example, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`. This could lead to `NameError` for previously existing type annotations.
  Fix: Review your code for any custom `TypeDef` annotations derived from `mypy-boto3` and update their names according to the new conventions. Refer to the `mypy-boto3` documentation or generated `.pyi` files for the exact new names.
• gotcha This package provides only type stubs for `boto3`'s MarketplaceEntitlementService. It does not include the runtime `boto3` library itself. Using the stubs without `boto3` installed will result in runtime `ModuleNotFoundError`.
  Fix: Always install `boto3` alongside `mypy-boto3-marketplace-entitlement` using `pip install boto3 mypy-boto3-marketplace-entitlement`.
• gotcha Compatibility with `mypy` itself can be a concern. Very old `mypy` versions may not fully understand the generated type stubs, especially with newer Python typing features.
  Fix: Keep your `mypy` installation up-to-date (`pip install --upgrade mypy`) to ensure full compatibility and accurate type checking.

Install

• pip install mypy-boto3-marketplace-entitlement boto3 mypy Install library, boto3, and mypy

Imports

• MarketplaceEntitlementClient

  from mypy_boto3_marketplace_entitlement import MarketplaceEntitlementClient

  The direct client class comes from the stub package, not boto3 itself for type hinting.
• GetEntitlementsResultTypeDef

  from mypy_boto3_marketplace_entitlement.type_defs import GetEntitlementsResultTypeDef

  Type definitions are typically found in the `type_defs` submodule for clarity.

Quickstart

This quickstart demonstrates how to initialize a `boto3` Marketplace Entitlement client with type annotations and make a sample API call. It shows how to import the specific client type and a common response `TypeDef` for robust type checking. Remember to install `boto3` and `mypy` alongside this stub package. Replace placeholder environment variables with actual values for execution.

import boto3
from mypy_boto3_marketplace_entitlement import MarketplaceEntitlementClient
from mypy_boto3_marketplace_entitlement.type_defs import GetEntitlementsResultTypeDef, GetEntitlementsRequestRequestTypeDef

# Instantiate a boto3 client with type hints
client: MarketplaceEntitlementClient = boto3.client("marketplace-entitlement")

# Example usage with type-hinted parameters and return value
request_params: GetEntitlementsRequestRequestTypeDef = {
    "ProductCode": os.environ.get('MARKETPLACE_PRODUCT_CODE', 'some-product-code'),
    "Filter": {
        "CUSTOMER_IDENTIFIER": [
            os.environ.get('AWS_ACCOUNT_ID', '123456789012')
        ]
    }
}

try:
    response: GetEntitlementsResultTypeDef = client.get_entitlements(**request_params)
    print("Successfully retrieved entitlements:")
    for entitlement in response.get('Entitlements', []):
        print(f"  Entitlement: {entitlement.get('ProductCode')} for {entitlement.get('CustomerIdentifier')}")
except Exception as e:
    print(f"Error retrieving entitlements: {e}")

# To verify with mypy, save this to a file (e.g., `main.py`) and run `mypy main.py`