Type annotations for boto3 SystemsManagerQuickSetup service

1.42.3 · active · verified Sat Apr 11

mypy-boto3-ssm-quicksetup provides type annotations for the `boto3` Systems Manager Quick Setup (SSM Quick Setup) service client, enabling static type checking with tools like `mypy` and enhancing IDE auto-completion. This package is part of the `mypy-boto3-builder` ecosystem, which generates stubs for all `boto3` services. It is currently at version 1.42.3 and generally aligns its major version with the corresponding `boto3` release, while the `mypy-boto3-builder` itself has its own release cadence.

Warnings

breaking Python 3.8 support was removed in `mypy-boto3-builder` version 8.12.0. All generated stub packages, including `mypy-boto3-ssm-quicksetup`, now require Python 3.9 or newer.
Fix: Upgrade your Python environment to 3.9 or later.
breaking The `mypy-boto3-builder` migrated to PEP 561 compliant packages in version 8.12.0. While largely backward compatible, older type-checking setups or custom build processes might need adjustments.
Fix: Ensure your `mypy` and IDE configurations are up-to-date and compatible with PEP 561 stub packages. Typically, simply installing the stub package alongside `boto3` is sufficient.
breaking Type definition naming conventions changed in `mypy-boto3-builder` 8.9.0. Some TypeDefs for method arguments might have shorter names (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes moved to the end.
Fix: Review your code for any explicit imports or references to `TypeDef` names and update them according to the new naming scheme if affected.
gotcha For optimal IDE support (especially PyCharm) and auto-discovery of types without explicit annotations, it is generally recommended to install the umbrella package `boto3-stubs` with the service extra (e.g., `pip install 'boto3-stubs[ssm-quicksetup]'`). Standalone packages like `mypy-boto3-ssm-quicksetup` often require explicit type annotations for `boto3.client()` calls.
Fix: Either install `boto3-stubs` with the service extra, or explicitly type-hint your `boto3.client()` calls (e.g., `client: SystemsManagerQuickSetupClient = session.client("ssm-quicksetup")`).
gotcha PyCharm users might experience slow performance with `Literal` overloads. It is sometimes recommended to use `boto3-stubs-lite` (which sacrifices some overload information for performance) or to disable PyCharm's internal type checker and rely on external tools like `mypy` or `pyright`.
Fix: Consider `pip install boto3-stubs-lite[ssm-quicksetup]` or configure PyCharm to use an external type checker.
deprecated The old naming convention `mypy-boto3-*` is considered legacy. The `mypy-boto3` package itself has been deprecated in favor of `types-boto3`. While `mypy-boto3-ssm-quicksetup` still exists, new projects might prefer `types-boto3` with service extras for consistency.
Fix: For new projects, consider using `types-boto3` directly with the appropriate service extra: `pip install 'types-boto3[ssm-quicksetup]'`.

Install

pip install mypy-boto3-ssm-quicksetup boto3 Install standalone stubs and boto3
pip install 'boto3-stubs[ssm-quicksetup]' boto3 Install via boto3-stubs extras (recommended for implicit typing)

Imports

SystemsManagerQuickSetupClient
```
from mypy_boto3_ssm_quicksetup.client import SystemsManagerQuickSetupClient
```
This is the explicit type for the SSM Quick Setup client. For implicit typing (recommended with `boto3-stubs`), direct import might not be needed.
CreateQuickSetupTypeDef
```
from mypy_boto3_ssm_quicksetup.type_defs import CreateQuickSetupTypeDef
```
Type definition for input parameters, useful for strict type checking of service calls.

Quickstart

This quickstart demonstrates how to obtain a type-hinted `SystemsManagerQuickSetupClient` using `boto3` and its type stubs. It includes an example of a service call, with the input and output types also annotated. Run this code with `mypy` to verify type correctness.

import boto3
from boto3.session import Session
from mypy_boto3_ssm_quicksetup.client import SystemsManagerQuickSetupClient
from mypy_boto3_ssm_quicksetup.type_defs import ListQuickSetupActionsResponseTypeDef


def get_ssm_quicksetup_client() -> SystemsManagerQuickSetupClient:
    """Returns a type-hinted SSM Quick Setup client."""
    session: Session = boto3.session.Session()
    client: SystemsManagerQuickSetupClient = session.client("ssm-quicksetup")
    return client


if __name__ == "__main__":
    ssm_qs_client = get_ssm_quicksetup_client()
    
    # Example: List Quick Setup Actions (dummy call for demonstration)
    # In a real scenario, you would provide actual parameters.
    try:
        response: ListQuickSetupActionsResponseTypeDef = ssm_qs_client.list_quick_setup_actions()
        print("Successfully retrieved Quick Setup actions (type-checked).")
        # print(response)
    except Exception as e:
        print(f"An error occurred: {e}")

view raw JSON →