mypy-boto3-meteringmarketplace Type Annotations

Warnings

• breaking Python 3.8 support was removed in `mypy-boto3-builder` version 8.12.0 and later. Ensure your project runs on Python 3.9 or higher. [cite: 8.12.0 release notes]
  Fix: Upgrade your Python environment to 3.9 or newer.
• breaking Starting with `mypy-boto3-builder` 8.9.0, some `TypeDef` names were shortened (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`) and conflicting `TypeDef` postfixes were reordered. [cite: 8.9.0 release notes]
  Fix: Review your explicit `TypedDict` imports and usages, and update names according to the latest generated stubs.
• gotcha The `mypy-boto3-builder` project migrated to PEP 561 packages in version 8.12.0. This might affect how type checkers discover stubs in complex project setups or older environments. [cite: 8.12.0 release notes]
  Fix: Ensure your type checker (e.g., mypy, pyright) is up-to-date and configured to correctly resolve PEP 561 packages. Most modern setups should handle this automatically.
• gotcha If you experience slow performance or high CPU usage with PyCharm, especially with `Literal` overloads, it is recommended to use the `boto3-stubs-lite` version instead. This offers a more RAM-friendly experience at the cost of requiring more explicit type annotations.
  Fix: Install the lite version: `pip install boto3-stubs-lite[meteringmarketplace]` or disable PyCharm's type checker and rely on external tools like mypy/pyright.
• gotcha For Pylint compatibility, if it complains about undefined variables when using type hints, consider wrapping your stub imports with `if TYPE_CHECKING:` blocks and assigning `object` to the types outside the block.
  Fix: Implement the `if TYPE_CHECKING:` pattern as shown in the quickstart example, ensuring Pylint correctly parses the code during non-type-checking runs.
• gotcha AWS service names can change or be deprecated (e.g., `sms-voice` was replaced by `pinpoint-sms-voice` in `mypy-boto3-builder` 8.11.0). If a service client or type definition is not found, verify the current service name in `boto3` documentation. [cite: 8.11.0 release notes]
  Fix: Consult the official `boto3` documentation or `mypy-boto3-builder` releases for any service name changes and update your imports accordingly.

Install

• pip install mypy-boto3-meteringmarketplace Install service stubs
• pip install boto3 mypy-boto3-meteringmarketplace Install with boto3

Imports

• MarketplaceMeteringClient

  from mypy_boto3_meteringmarketplace.client import MarketplaceMeteringClient

  Import the typed client for the MarketplaceMetering service.
• RegisterUsageOutputTypeDef

  from mypy_boto3_meteringmarketplace.type_defs import RegisterUsageOutputTypeDef

  Import specific TypedDicts for request/response structures.

Quickstart

This quickstart demonstrates how to initialize a typed `MarketplaceMeteringClient` and make a sample API call like `register_usage`. Type hints are applied for the client and the response, leveraging the installed `mypy-boto3-meteringmarketplace` stubs. Replace placeholder values with actual AWS credentials and valid Marketplace Metering data. The `TYPE_CHECKING` block ensures that stub imports are only active during type checking, avoiding runtime dependencies on stub packages.

import os
import boto3
from typing import TYPE_CHECKING

# Ensure you have boto3 installed for runtime and mypy-boto3-meteringmarketplace for type checking

if TYPE_CHECKING:
    from mypy_boto3_meteringmarketplace.client import MarketplaceMeteringClient
    from mypy_boto3_meteringmarketplace.type_defs import RegisterUsageOutputTypeDef

# Standard boto3 client creation (runtime)
client: MarketplaceMeteringClient = boto3.client(
    "meteringmarketplace",
    region_name=os.environ.get("AWS_REGION", "us-east-1"),
    aws_access_key_id=os.environ.get("AWS_ACCESS_KEY_ID", ""),
    aws_secret_access_key=os.environ.get("AWS_SECRET_ACCESS_KEY", ""),
    aws_session_token=os.environ.get("AWS_SESSION_TOKEN", ""),
)

try:
    # Example: Registering usage. Note: ProductCode and UsageAllocations are required.
    # This is a dummy example; replace with actual logic and valid data.
    product_code = "YOUR_PRODUCT_CODE"
    usage_allocations = [
        {"AllocatedUsageQuantity": 1, "Tags": [{"Key": "Dim", "Value": "Val"}]}
    ]

    response: RegisterUsageOutputTypeDef = client.register_usage(
        ProductCode=product_code,
        UsageAllocations=usage_allocations,
        UsageQuantity=1, # Deprecated, UsageAllocations is preferred
        Timestamp=int(os.time.time()),
    )
    print(f"Usage registration successful: {response.get('UsageMeteringRecordId')}")

except client.exceptions.ProductCodeNotFoundException:
    print(f"Error: Product code '{product_code}' not found.")
except Exception as e:
    print(f"An error occurred: {e}")