mypy-boto3-simpledbv2

Warnings

• breaking As of `mypy-boto3-builder` version 8.12.0 (which generated this package version), Python 3.8 support has been dropped. All `mypy-boto3` packages now require Python 3.9 or higher.
  Fix: Upgrade your Python environment to 3.9 or newer. If you must use Python 3.8, use an older `mypy-boto3` version (e.g., `<8.8.0` for builder versions before 8.8.0 reintroduced 3.8 support, or `<8.12.0` for versions after that, but before the final drop in 8.12.0).
• breaking Beginning with `mypy-boto3-builder` version 8.9.0, some TypeDef naming conventions were changed (e.g., `CreateDistributionRequestRequestTypeDef` might become `CreateDistributionRequestTypeDef`). While the specific example is for a different service, this is a builder-wide change that may affect explicit type annotations in your code for SimpleDBv2 request/response payloads.
  Fix: Review and update any explicit TypeDef annotations in your code to match the new, potentially shorter, generated names. Refer to the specific `mypy_boto3_simpledbv2.type_defs` module for correct names.
• gotcha This package only provides type stubs. You must install `boto3` separately for actual AWS API calls. This package does not install `boto3` as a dependency.
  Fix: Ensure `boto3` is installed in your environment: `pip install boto3`.
• gotcha Each AWS service requires its own `mypy-boto3-<service-name>` package for comprehensive type checking. Installing `mypy-boto3-simpledbv2` only provides types for SimpleDBv2, not other services like S3 or EC2.
  Fix: Install separate stub packages for each boto3 service you intend to type-check (e.g., `pip install mypy-boto3-s3 mypy-boto3-ec2`). Alternatively, install `mypy-boto3` for all stubs (`pip install mypy-boto3`).
• gotcha As of `mypy-boto3-builder` version 8.12.0, all packages migrated to PEP 561 compliance. This means `mypy` should automatically discover the type stubs without explicit configuration in `mypy.ini` (e.g., `plugins`). If you have old `mypy.ini` configurations for `mypy-boto3` plugins, they might now cause issues.
  Fix: Remove any `mypy_boto3.mypy_plugin.Boto3Plugin` entries from your `mypy.ini` or similar configuration files. Rely on PEP 561 discovery.

Install

• pip install mypy-boto3-simpledbv2 Install package

Imports

• SimpleDBv2Client
  wrong:

  from boto3.client import SimpleDBv2Client

  correct:

  from mypy_boto3_simpledbv2.client import SimpleDBv2Client

  The raw boto3 client does not provide full type hints. Import the typed client from mypy-boto3-simpledbv2.
• CreateDomainRequestTypeDef

  from mypy_boto3_simpledbv2.type_defs import CreateDomainRequestTypeDef

  Type definitions for request/response payloads are found in `type_defs`.
• ClientError

  from botocore.exceptions import ClientError

  Common exceptions like ClientError are part of botocore, which boto3 uses internally.

Quickstart

This quickstart demonstrates how to initialize a type-hinted SimpleDBv2 client and list available domains. The `mypy-boto3-simpledbv2` package provides the `SimpleDBv2Client` type, allowing static analysis tools like Mypy to verify your code against the AWS API.

import boto3
from mypy_boto3_simpledbv2.client import SimpleDBv2Client
from botocore.exceptions import ClientError

def list_simpledb_domains():
    """Lists SimpleDB domains using a typed boto3 client."""
    try:
        # Initialize a typed SimpleDBv2 client
        client: SimpleDBv2Client = boto3.client("sdb")

        # List domains with type-hinted response
        response = client.list_domains(MaxNumberOfDomains=10)
        
        print(f"SimpleDB Domains: {response.get('DomainNames', [])}")
        if response.get("NextToken"):
            print("More domains available (use NextToken).")

    except ClientError as e:
        print(f"Error listing SimpleDB domains: {e}")
    except Exception as e:
        print(f"An unexpected error occurred: {e}")

if __name__ == "__main__":
    # Ensure AWS credentials are configured (e.g., via environment variables, ~/.aws/credentials)
    list_simpledb_domains()