Type annotations for aiobotocore SSM

Common errors

• ModuleNotFoundError: No module named 'types_aiobotocore_ssm'

  cause The `types-aiobotocore-ssm` package is either not installed, or there is a typo in the import statement.
  fix Ensure the package is installed with `pip install types-aiobotocore-ssm`. Verify the import path is `from types_aiobotocore_ssm.client import SSMClient` (using underscores, not hyphens).

• TypeError: Argument of type 'SSMClient' cannot be assigned to parameter 'client' of type 'SSMClient' in aiobotocore.session.ClientCreator.create_client

  cause This error, or similar type mismatches for `client` methods, often indicates that the `aiobotocore` runtime library is not installed, or that the type checker is not correctly linking the stubs with the runtime.
  fix Verify that `aiobotocore` is installed (`pip install aiobotocore`). Ensure your type checker (e.g., MyPy) is correctly configured and running against your environment. For explicit typing, consider `client: SSMClient` after `create_client`.

• AttributeError: 'SSMClient' object has no attribute 'send_command' (or similar method error)

  cause You are likely calling an asynchronous method on the `aiobotocore` client without using `await`, or attempting to use a `boto3` client method signature on an `aiobotocore` client.
  fix Ensure all client calls are `await`ed, as `aiobotocore` clients are asynchronous. For example, `await client.send_command(...)`. Also, double-check method names against `aiobotocore`'s documentation, as they might differ slightly from `boto3`.

Warnings

• breaking Python 3.8 support has been removed from all `mypy-boto3-builder` generated stub packages, including `types-aiobotocore-ssm`, starting with `mypy-boto3-builder` version 8.12.0.
  Fix: Upgrade your Python interpreter to version 3.9 or newer.
• breaking Type definition (TypeDef) naming conventions were changed in `mypy-boto3-builder` version 8.9.0. This includes shorter names for packed method arguments (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`) and moving the `Extra` postfix. Code explicitly importing and using these TypeDefs may break.
  Fix: Review your code for any explicit imports or usage of `TypeDef` names, and update them according to the new naming conventions. Consult the specific service's `type_defs.pyi` for correct names if unsure.
• gotcha `types-aiobotocore-ssm` provides only type annotations (stubs) for the `aiobotocore` SSM client. It does not include the actual `aiobotocore` runtime library, which must be installed separately for your application to function.
  Fix: Always ensure `aiobotocore` is installed in your environment alongside `types-aiobotocore-ssm`. For example: `pip install types-aiobotocore-ssm aiobotocore`.
• gotcha As of `mypy-boto3-builder` 8.12.0, stub packages have migrated to PEP 561 compliance. This means stubs are installed alongside the runtime library and are automatically discovered by type checkers like MyPy. If you had custom configurations for stub discovery, they might need adjustment.
  Fix: Ensure your type checker is up-to-date and correctly configured to find PEP 561-style stub packages. Most common setups should work without manual intervention.
• gotcha PyCharm users might experience slow performance or high CPU usage with Literal overloads in type stubs (issue PY-40997).
  Fix: Consider using `types-aiobotocore-lite` instead, which is more RAM-friendly. Alternatively, disable PyCharm's internal type checker and use an external tool like `mypy` or `pyright` for type checking.

Install

• pip install types-aiobotocore-ssm aiobotocore Install with runtime dependency
• pip install 'types-aiobotocore[ssm]' aiobotocore Install as part of types-aiobotocore bundle

Imports

• SSMClient

  from types_aiobotocore_ssm.client import SSMClient

  Main client type for SSM service operations.
• CommandExecutedWaiter

  from types_aiobotocore_ssm.waiter import CommandExecutedWaiter

  Type annotation for the `CommandExecuted` waiter.
• AccountSharingInfoTypeDef

  from types_aiobotocore_ssm.type_defs import AccountSharingInfoTypeDef

  Example of importing a generated TypedDict for request/response structures.
• AccessRequestStatusType

  from types_aiobotocore_ssm.literals import AccessRequestStatusType

  Example of importing a literal type for static checking.

Quickstart

This quickstart demonstrates how to use `types-aiobotocore-ssm` with `aiobotocore` to create a typed SSM client, call an asynchronous operation, and retrieve a typed waiter. Explicit type annotations (e.g., `# type: SSMClient`) are optional but can improve clarity and provide better IDE support. Remember to install `aiobotocore` as a runtime dependency.

import asyncio
from aiobotocore.session import get_session
from types_aiobotocore_ssm.client import SSMClient
from types_aiobotocore_ssm.waiter import CommandExecutedWaiter

async def describe_instance_information():
    session = get_session()
    async with session.create_client("ssm") as client: # type: SSMClient
        # Use explicit type annotation for client for clarity, though often inferred
        print("Describing instance information...")
        response = await client.describe_instance_information(
            MaxResults=5
        )
        print(f"Instances: {[instance['InstanceId'] for instance in response.get('InstanceInformationList', [])]}")

        # Example of using a waiter
        print("Getting CommandExecuted waiter...")
        waiter: CommandExecutedWaiter = client.get_waiter("command_executed")
        # await waiter.wait(CommandId="your-command-id", InstanceId="your-instance-id")
        print("Waiter retrieved. Actual wait requires command/instance IDs.")

if __name__ == "__main__":
    asyncio.run(describe_instance_information())