{"id":3706,"library":"mypy-boto3-ssm-quicksetup","title":"Type annotations for boto3 SystemsManagerQuickSetup service","description":"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.","status":"active","version":"1.42.3","language":"en","source_language":"en","source_url":"https://github.com/youtype/mypy_boto3_builder","tags":["mypy","boto3","aws","typing","stubs","ssm-quicksetup","type-annotations","systems-manager"],"install":[{"cmd":"pip install mypy-boto3-ssm-quicksetup boto3","lang":"bash","label":"Install standalone stubs and boto3"},{"cmd":"pip install 'boto3-stubs[ssm-quicksetup]' boto3","lang":"bash","label":"Install via boto3-stubs extras (recommended for implicit typing)"}],"dependencies":[{"reason":"Provides the runtime AWS SDK that these type stubs annotate.","package":"boto3","optional":false},{"reason":"Requires Python 3.9 or newer.","package":"python","optional":false}],"imports":[{"note":"This is the explicit type for the SSM Quick Setup client. For implicit typing (recommended with `boto3-stubs`), direct import might not be needed.","symbol":"SystemsManagerQuickSetupClient","correct":"from mypy_boto3_ssm_quicksetup.client import SystemsManagerQuickSetupClient"},{"note":"Type definition for input parameters, useful for strict type checking of service calls.","symbol":"CreateQuickSetupTypeDef","correct":"from mypy_boto3_ssm_quicksetup.type_defs import CreateQuickSetupTypeDef"}],"quickstart":{"code":"import boto3\nfrom boto3.session import Session\nfrom mypy_boto3_ssm_quicksetup.client import SystemsManagerQuickSetupClient\nfrom mypy_boto3_ssm_quicksetup.type_defs import ListQuickSetupActionsResponseTypeDef\n\n\ndef get_ssm_quicksetup_client() -> SystemsManagerQuickSetupClient:\n    \"\"\"Returns a type-hinted SSM Quick Setup client.\"\"\"\n    session: Session = boto3.session.Session()\n    client: SystemsManagerQuickSetupClient = session.client(\"ssm-quicksetup\")\n    return client\n\n\nif __name__ == \"__main__\":\n    ssm_qs_client = get_ssm_quicksetup_client()\n    \n    # Example: List Quick Setup Actions (dummy call for demonstration)\n    # In a real scenario, you would provide actual parameters.\n    try:\n        response: ListQuickSetupActionsResponseTypeDef = ssm_qs_client.list_quick_setup_actions()\n        print(\"Successfully retrieved Quick Setup actions (type-checked).\")\n        # print(response)\n    except Exception as e:\n        print(f\"An error occurred: {e}\")\n","lang":"python","description":"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."},"warnings":[{"fix":"Upgrade your Python environment to 3.9 or later.","message":"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.","severity":"breaking","affected_versions":">=8.12.0 of mypy-boto3-builder (impacts mypy-boto3-ssm-quicksetup from 1.42.3 onwards)"},{"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.","message":"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.","severity":"breaking","affected_versions":">=8.12.0 of mypy-boto3-builder (impacts mypy-boto3-ssm-quicksetup from 1.42.3 onwards)"},{"fix":"Review your code for any explicit imports or references to `TypeDef` names and update them according to the new naming scheme if affected.","message":"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.","severity":"breaking","affected_versions":">=8.9.0 of mypy-boto3-builder"},{"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\")`).","message":"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.","severity":"gotcha","affected_versions":"All versions"},{"fix":"Consider `pip install boto3-stubs-lite[ssm-quicksetup]` or configure PyCharm to use an external type checker.","message":"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`.","severity":"gotcha","affected_versions":"All versions, specifically PyCharm 2020.3+"},{"fix":"For new projects, consider using `types-boto3` directly with the appropriate service extra: `pip install 'types-boto3[ssm-quicksetup]'`.","message":"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.","severity":"deprecated","affected_versions":"All `mypy-boto3-*` packages, specifically since `mypy-boto3-builder` 8.9.0 changed how legacy `mypy-boto3` is handled."}],"env_vars":null,"last_verified":"2026-04-11T00:00:00.000Z","next_check":"2026-07-10T00:00:00.000Z"}