Type annotations for boto3 Outposts

Warnings

• breaking Python 3.8 support was removed in `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 or older must upgrade their Python version to >=3.9 or use an older version of `mypy-boto3-outposts` and its builder.
  Fix: Upgrade Python to 3.9 or higher. Alternatively, pin `mypy-boto3-builder` to a version older than 8.12.0 if using Python 3.8.
• breaking Breaking changes to `TypeDef` names occurred in `mypy-boto3-builder` version 8.9.0. Packed method arguments now use shorter names (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes were moved (e.g., `CreateDistributionExtraRequestTypeDef` to `CreateDistributionRequestExtraTypeDef`).
  Fix: Update your code to use the new `TypeDef` naming conventions as reflected in the generated stubs.
• gotcha The `mypy-boto3` ecosystem migrated to PEP 561 compliant stub-only packages starting with `mypy-boto3-builder` 8.12.0. This means `mypy` will typically auto-discover types if the packages are installed, but users should be aware that `MYPYPATH` is not used for stub-only packages and direct installation is necessary for type checkers to find them.
  Fix: Ensure `mypy-boto3-outposts` is installed in the same Python environment used by your type checker. No special `MYPYPATH` configuration is needed or supported for stub-only packages.
• deprecated A pattern of service renaming/deprecation exists within the `mypy-boto3` ecosystem. For example, the `sms-voice` service was deprecated in favor of `pinpoint-sms-voice` in builder 8.11.0. While specific to `sms-voice`, this indicates that users should periodically check release notes for service-specific stub deprecations or renames.
  Fix: Consult the changelog for the specific `mypy-boto3-*` package or the `mypy-boto3-builder` repository for any service renames or deprecations relevant to your project.
• gotcha The legacy `mypy-boto3` package was moved to a separate product starting in `mypy-boto3-builder` 8.9.0 and is no longer generated alongside `boto3-stubs`. Users upgrading from older `mypy-boto3` installations might need to adjust their package names or rebuild their stubs.
  Fix: Ensure you are installing `boto3-stubs` or specific `mypy-boto3-` service packages, rather than relying on the older `mypy-boto3` package for new projects or after upgrading the builder.

Install

• pip install mypy-boto3-outposts Install with pip

Imports

• OutpostsClient

  from mypy_boto3_outposts.client import OutpostsClient

  While boto3.client('outposts') returns a client, for static type checking with mypy-boto3-outposts, you need to import the specific client type from the stubs package for full benefits.
• CreateOutpostInputRequestTypeDef

  from mypy_boto3_outposts.type_defs import CreateOutpostInputRequestTypeDef

  Type definitions for service requests and responses are typically found in the `type_defs` submodule.

Quickstart

This quickstart demonstrates how to obtain a type-hinted `OutpostsClient` from `boto3` and use it to interact with the AWS Outposts service. The type annotations provided by `mypy-boto3-outposts` enable robust static analysis and IDE auto-completion for client methods and response structures.

import boto3
from mypy_boto3_outposts.client import OutpostsClient

def get_outposts_client() -> OutpostsClient:
    """Returns a type-hinted Outposts client."""
    client: OutpostsClient = boto3.client("outposts")
    return client

if __name__ == "__main__":
    outposts_client = get_outposts_client()
    try:
        # Example: List outposts
        response = outposts_client.list_outposts()
        print(f"Found {len(response.get('Outposts', []))} Outposts.")
        if response.get('Outposts'):
            print(f"First Outpost ARN: {response['Outposts'][0]['OutpostArn']}")
    except Exception as e:
        print(f"An error occurred: {e}")