types-aiobotocore-ssm


Nametypes-aiobotocore-ssm JSON
Version 2.15.2 PyPI version JSON
download
home_pagehttps://github.com/youtype/mypy_boto3_builder
SummaryType annotations for aiobotocore.SSM 2.15.2 service generated with mypy-boto3-builder 8.1.2
upload_time2024-10-10 01:39:43
maintainerNone
docs_urlNone
authorVlad Emelianov
requires_python>=3.8
licenseMIT License
keywords aiobotocore ssm type-annotations botocore mypy typeshed autocomplete
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <a id="types-aiobotocore-ssm"></a>

# types-aiobotocore-ssm

[![PyPI - types-aiobotocore-ssm](https://img.shields.io/pypi/v/types-aiobotocore-ssm.svg?color=blue)](https://pypi.org/project/types-aiobotocore-ssm)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-aiobotocore-ssm.svg?color=blue)](https://pypi.org/project/types-aiobotocore-ssm)
[![Docs](https://img.shields.io/readthedocs/types-aiobotocore.svg?color=blue)](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_ssm/)
[![PyPI - Downloads](https://static.pepy.tech/badge/types-aiobotocore-ssm)](https://pepy.tech/project/types-aiobotocore-ssm)

![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)

Type annotations for
[aiobotocore.SSM 2.15.2](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm.html#SSM)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.

Generated by
[mypy-boto3-builder 8.1.2](https://github.com/youtype/mypy_boto3_builder).

More information can be found on
[types-aiobotocore](https://pypi.org/project/types-aiobotocore/) page and in
[types-aiobotocore-ssm docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_ssm/).

See how it helps to find and fix potential bugs:

![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)

- [types-aiobotocore-ssm](#types-aiobotocore-ssm)
  - [How to install](#how-to-install)
    - [From PyPI with pip](#from-pypi-with-pip)
  - [How to uninstall](#how-to-uninstall)
  - [Usage](#usage)
    - [VSCode](#vscode)
    - [PyCharm](#pycharm)
    - [Emacs](#emacs)
    - [Sublime Text](#sublime-text)
    - [Other IDEs](#other-ides)
    - [mypy](#mypy)
    - [pyright](#pyright)
  - [Explicit type annotations](#explicit-type-annotations)
    - [Client annotations](#client-annotations)
    - [Paginators annotations](#paginators-annotations)
    - [Waiters annotations](#waiters-annotations)
    - [Literals](#literals)
    - [Type definitions](#type-definitions)
  - [How it works](#how-it-works)
  - [What's new](#what's-new)
    - [Implemented features](#implemented-features)
    - [Latest changes](#latest-changes)
  - [Versioning](#versioning)
  - [Thank you](#thank-you)
  - [Documentation](#documentation)
  - [Support and contributing](#support-and-contributing)

<a id="how-to-install"></a>

## How to install

<a id="from-pypi-with-pip"></a>

### From PyPI with pip

Install `types-aiobotocore` for `SSM` service.

```bash
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[ssm]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[ssm]'


# standalone installation
python -m pip install types-aiobotocore-ssm
```

<a id="how-to-uninstall"></a>

## How to uninstall

```bash
python -m pip uninstall -y types-aiobotocore-ssm
```

<a id="usage"></a>

## Usage

<a id="vscode"></a>

### VSCode

- Install
  [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
  [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `types-aiobotocore[ssm]` in your environment:

```bash
python -m pip install 'types-aiobotocore[ssm]'
```

Both type checking and code completion should now work. No explicit type
annotations required, write your `aiobotocore` code as usual.

<a id="pycharm"></a>

### PyCharm

Install `types-aiobotocore-lite[ssm]` in your environment:

```bash
python -m pip install 'types-aiobotocore-lite[ssm]'`
```

Both type checking and code completion should now work. Explicit type
annotations **are required**.

Use `types-aiobotocore` package instead for implicit type discovery.

<a id="emacs"></a>

### Emacs

- Install `types-aiobotocore` with services you use in your environment:

```bash
python -m pip install 'types-aiobotocore[ssm]'
```

- Install [use-package](https://github.com/jwiegley/use-package),
  [lsp](https://github.com/emacs-lsp/lsp-mode/),
  [company](https://github.com/company-mode/company-mode) and
  [flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

```elisp
(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )
```

- Make sure emacs uses the environment where you have installed
  `types-aiobotocore`

Type checking should now work. No explicit type annotations required, write
your `aiobotocore` code as usual.

<a id="sublime-text"></a>

### Sublime Text

- Install `types-aiobotocore[ssm]` with services you use in your environment:

```bash
python -m pip install 'types-aiobotocore[ssm]'
```

- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package

Type checking should now work. No explicit type annotations required, write
your `aiobotocore` code as usual.

<a id="other-ides"></a>

### Other IDEs

Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.

<a id="mypy"></a>

### mypy

- Install `mypy`: `python -m pip install mypy`
- Install `types-aiobotocore[ssm]` in your environment:

```bash
python -m pip install 'types-aiobotocore[ssm]'
```

Type checking should now work. No explicit type annotations required, write
your `aiobotocore` code as usual.

<a id="pyright"></a>

### pyright

- Install `pyright`: `npm i -g pyright`
- Install `types-aiobotocore[ssm]` in your environment:

```bash
python -m pip install 'types-aiobotocore[ssm]'
```

Optionally, you can install `types-aiobotocore` to `typings` directory.

Type checking should now work. No explicit type annotations required, write
your `aiobotocore` code as usual.

<a id="explicit-type-annotations"></a>

## Explicit type annotations

<a id="client-annotations"></a>

### Client annotations

`SSMClient` provides annotations for `session.create_client("ssm")`.

```python
from aiobotocore.session import get_session

from types_aiobotocore_ssm import SSMClient

session = get_session()
async with session.create_client("ssm") as client:
    client: SSMClient
    # now client usage is checked by mypy and IDE should provide code completion
```

<a id="paginators-annotations"></a>

### Paginators annotations

`types_aiobotocore_ssm.paginator` module contains type annotations for all
paginators.

```python
from aiobotocore.session import get_session

from types_aiobotocore_ssm import SSMClient
from types_aiobotocore_ssm.paginator import (
    DescribeActivationsPaginator,
    DescribeAssociationExecutionTargetsPaginator,
    DescribeAssociationExecutionsPaginator,
    DescribeAutomationExecutionsPaginator,
    DescribeAutomationStepExecutionsPaginator,
    DescribeAvailablePatchesPaginator,
    DescribeEffectiveInstanceAssociationsPaginator,
    DescribeEffectivePatchesForPatchBaselinePaginator,
    DescribeInstanceAssociationsStatusPaginator,
    DescribeInstanceInformationPaginator,
    DescribeInstancePatchStatesPaginator,
    DescribeInstancePatchStatesForPatchGroupPaginator,
    DescribeInstancePatchesPaginator,
    DescribeInstancePropertiesPaginator,
    DescribeInventoryDeletionsPaginator,
    DescribeMaintenanceWindowExecutionTaskInvocationsPaginator,
    DescribeMaintenanceWindowExecutionTasksPaginator,
    DescribeMaintenanceWindowExecutionsPaginator,
    DescribeMaintenanceWindowSchedulePaginator,
    DescribeMaintenanceWindowTargetsPaginator,
    DescribeMaintenanceWindowTasksPaginator,
    DescribeMaintenanceWindowsPaginator,
    DescribeMaintenanceWindowsForTargetPaginator,
    DescribeOpsItemsPaginator,
    DescribeParametersPaginator,
    DescribePatchBaselinesPaginator,
    DescribePatchGroupsPaginator,
    DescribePatchPropertiesPaginator,
    DescribeSessionsPaginator,
    GetInventoryPaginator,
    GetInventorySchemaPaginator,
    GetOpsSummaryPaginator,
    GetParameterHistoryPaginator,
    GetParametersByPathPaginator,
    GetResourcePoliciesPaginator,
    ListAssociationVersionsPaginator,
    ListAssociationsPaginator,
    ListCommandInvocationsPaginator,
    ListCommandsPaginator,
    ListComplianceItemsPaginator,
    ListComplianceSummariesPaginator,
    ListDocumentVersionsPaginator,
    ListDocumentsPaginator,
    ListOpsItemEventsPaginator,
    ListOpsItemRelatedItemsPaginator,
    ListOpsMetadataPaginator,
    ListResourceComplianceSummariesPaginator,
    ListResourceDataSyncPaginator,
)

session = get_session()
async with session.create_client("ssm") as client:
    client: SSMClient

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    describe_activations_paginator: DescribeActivationsPaginator = client.get_paginator(
        "describe_activations"
    )
    describe_association_execution_targets_paginator: DescribeAssociationExecutionTargetsPaginator = client.get_paginator(
        "describe_association_execution_targets"
    )
    describe_association_executions_paginator: DescribeAssociationExecutionsPaginator = (
        client.get_paginator("describe_association_executions")
    )
    describe_automation_executions_paginator: DescribeAutomationExecutionsPaginator = (
        client.get_paginator("describe_automation_executions")
    )
    describe_automation_step_executions_paginator: DescribeAutomationStepExecutionsPaginator = (
        client.get_paginator("describe_automation_step_executions")
    )
    describe_available_patches_paginator: DescribeAvailablePatchesPaginator = client.get_paginator(
        "describe_available_patches"
    )
    describe_effective_instance_associations_paginator: DescribeEffectiveInstanceAssociationsPaginator = client.get_paginator(
        "describe_effective_instance_associations"
    )
    describe_effective_patches_for_patch_baseline_paginator: DescribeEffectivePatchesForPatchBaselinePaginator = client.get_paginator(
        "describe_effective_patches_for_patch_baseline"
    )
    describe_instance_associations_status_paginator: DescribeInstanceAssociationsStatusPaginator = (
        client.get_paginator("describe_instance_associations_status")
    )
    describe_instance_information_paginator: DescribeInstanceInformationPaginator = (
        client.get_paginator("describe_instance_information")
    )
    describe_instance_patch_states_paginator: DescribeInstancePatchStatesPaginator = (
        client.get_paginator("describe_instance_patch_states")
    )
    describe_instance_patch_states_for_patch_group_paginator: DescribeInstancePatchStatesForPatchGroupPaginator = client.get_paginator(
        "describe_instance_patch_states_for_patch_group"
    )
    describe_instance_patches_paginator: DescribeInstancePatchesPaginator = client.get_paginator(
        "describe_instance_patches"
    )
    describe_instance_properties_paginator: DescribeInstancePropertiesPaginator = (
        client.get_paginator("describe_instance_properties")
    )
    describe_inventory_deletions_paginator: DescribeInventoryDeletionsPaginator = (
        client.get_paginator("describe_inventory_deletions")
    )
    describe_maintenance_window_execution_task_invocations_paginator: DescribeMaintenanceWindowExecutionTaskInvocationsPaginator = client.get_paginator(
        "describe_maintenance_window_execution_task_invocations"
    )
    describe_maintenance_window_execution_tasks_paginator: DescribeMaintenanceWindowExecutionTasksPaginator = client.get_paginator(
        "describe_maintenance_window_execution_tasks"
    )
    describe_maintenance_window_executions_paginator: DescribeMaintenanceWindowExecutionsPaginator = client.get_paginator(
        "describe_maintenance_window_executions"
    )
    describe_maintenance_window_schedule_paginator: DescribeMaintenanceWindowSchedulePaginator = (
        client.get_paginator("describe_maintenance_window_schedule")
    )
    describe_maintenance_window_targets_paginator: DescribeMaintenanceWindowTargetsPaginator = (
        client.get_paginator("describe_maintenance_window_targets")
    )
    describe_maintenance_window_tasks_paginator: DescribeMaintenanceWindowTasksPaginator = (
        client.get_paginator("describe_maintenance_window_tasks")
    )
    describe_maintenance_windows_paginator: DescribeMaintenanceWindowsPaginator = (
        client.get_paginator("describe_maintenance_windows")
    )
    describe_maintenance_windows_for_target_paginator: DescribeMaintenanceWindowsForTargetPaginator = client.get_paginator(
        "describe_maintenance_windows_for_target"
    )
    describe_ops_items_paginator: DescribeOpsItemsPaginator = client.get_paginator(
        "describe_ops_items"
    )
    describe_parameters_paginator: DescribeParametersPaginator = client.get_paginator(
        "describe_parameters"
    )
    describe_patch_baselines_paginator: DescribePatchBaselinesPaginator = client.get_paginator(
        "describe_patch_baselines"
    )
    describe_patch_groups_paginator: DescribePatchGroupsPaginator = client.get_paginator(
        "describe_patch_groups"
    )
    describe_patch_properties_paginator: DescribePatchPropertiesPaginator = client.get_paginator(
        "describe_patch_properties"
    )
    describe_sessions_paginator: DescribeSessionsPaginator = client.get_paginator(
        "describe_sessions"
    )
    get_inventory_paginator: GetInventoryPaginator = client.get_paginator("get_inventory")
    get_inventory_schema_paginator: GetInventorySchemaPaginator = client.get_paginator(
        "get_inventory_schema"
    )
    get_ops_summary_paginator: GetOpsSummaryPaginator = client.get_paginator("get_ops_summary")
    get_parameter_history_paginator: GetParameterHistoryPaginator = client.get_paginator(
        "get_parameter_history"
    )
    get_parameters_by_path_paginator: GetParametersByPathPaginator = client.get_paginator(
        "get_parameters_by_path"
    )
    get_resource_policies_paginator: GetResourcePoliciesPaginator = client.get_paginator(
        "get_resource_policies"
    )
    list_association_versions_paginator: ListAssociationVersionsPaginator = client.get_paginator(
        "list_association_versions"
    )
    list_associations_paginator: ListAssociationsPaginator = client.get_paginator(
        "list_associations"
    )
    list_command_invocations_paginator: ListCommandInvocationsPaginator = client.get_paginator(
        "list_command_invocations"
    )
    list_commands_paginator: ListCommandsPaginator = client.get_paginator("list_commands")
    list_compliance_items_paginator: ListComplianceItemsPaginator = client.get_paginator(
        "list_compliance_items"
    )
    list_compliance_summaries_paginator: ListComplianceSummariesPaginator = client.get_paginator(
        "list_compliance_summaries"
    )
    list_document_versions_paginator: ListDocumentVersionsPaginator = client.get_paginator(
        "list_document_versions"
    )
    list_documents_paginator: ListDocumentsPaginator = client.get_paginator("list_documents")
    list_ops_item_events_paginator: ListOpsItemEventsPaginator = client.get_paginator(
        "list_ops_item_events"
    )
    list_ops_item_related_items_paginator: ListOpsItemRelatedItemsPaginator = client.get_paginator(
        "list_ops_item_related_items"
    )
    list_ops_metadata_paginator: ListOpsMetadataPaginator = client.get_paginator(
        "list_ops_metadata"
    )
    list_resource_compliance_summaries_paginator: ListResourceComplianceSummariesPaginator = (
        client.get_paginator("list_resource_compliance_summaries")
    )
    list_resource_data_sync_paginator: ListResourceDataSyncPaginator = client.get_paginator(
        "list_resource_data_sync"
    )
```

<a id="waiters-annotations"></a>

### Waiters annotations

`types_aiobotocore_ssm.waiter` module contains type annotations for all
waiters.

```python
from aiobotocore.session import get_session

from types_aiobotocore_ssm.client import SSMClient
from types_aiobotocore_ssm.waiter import CommandExecutedWaiter

session = get_session()
async with session.create_client("ssm") as client:
    client: SSMClient

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    command_executed_waiter: CommandExecutedWaiter = client.get_waiter("command_executed")
```

<a id="literals"></a>

### Literals

`types_aiobotocore_ssm.literals` module contains literals extracted from shapes
that can be used in user code for type checking.

Full list of `SSM` Literals can be found in
[docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_ssm/literals/).

```python
from types_aiobotocore_ssm.literals import AssociationComplianceSeverityType


def check_value(value: AssociationComplianceSeverityType) -> bool: ...
```

<a id="type-definitions"></a>

### Type definitions

`types_aiobotocore_ssm.type_defs` module contains structures and shapes
assembled to typed dictionaries and unions for additional type checking.

Full list of `SSM` TypeDefs can be found in
[docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_ssm/type_defs/).

```python
from types_aiobotocore_ssm.type_defs import AccountSharingInfoTypeDef


def get_value() -> AccountSharingInfoTypeDef:
    return {...}
```

<a id="how-it-works"></a>

## How it works

Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for
`aiobotocore` updates. It delivers drop-in type annotations for you and makes
sure that:

- All available `aiobotocore` services are covered.
- Each public class and method of every `aiobotocore` service gets valid type
  annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.

<a id="what's-new"></a>

## What's new

<a id="implemented-features"></a>

### Implemented features

- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
  libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
  compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
  annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
  calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls

<a id="latest-changes"></a>

### Latest changes

Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).

<a id="versioning"></a>

## Versioning

`types-aiobotocore-ssm` version is the same as related `aiobotocore` version
and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.

<a id="thank-you"></a>

## Thank you

- [Allie Fitter](https://github.com/alliefitter) for
  [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
  this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
  tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
  [isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
  for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
  Python

<a id="documentation"></a>

## Documentation

All services type annotations can be found in
[aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_ssm/)

<a id="support-and-contributing"></a>

## Support and contributing

This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/youtype/mypy_boto3_builder",
    "name": "types-aiobotocore-ssm",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "aiobotocore ssm type-annotations botocore mypy typeshed autocomplete",
    "author": "Vlad Emelianov",
    "author_email": "vlad.emelianov.nz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/70/62/a149816fc226294cc6de00f4ff3d6ea536aefa4e726f1db0a80c06d227bc/types_aiobotocore_ssm-2.15.2.tar.gz",
    "platform": null,
    "description": "<a id=\"types-aiobotocore-ssm\"></a>\n\n# types-aiobotocore-ssm\n\n[![PyPI - types-aiobotocore-ssm](https://img.shields.io/pypi/v/types-aiobotocore-ssm.svg?color=blue)](https://pypi.org/project/types-aiobotocore-ssm)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-aiobotocore-ssm.svg?color=blue)](https://pypi.org/project/types-aiobotocore-ssm)\n[![Docs](https://img.shields.io/readthedocs/types-aiobotocore.svg?color=blue)](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_ssm/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/types-aiobotocore-ssm)](https://pepy.tech/project/types-aiobotocore-ssm)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for\n[aiobotocore.SSM 2.15.2](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm.html#SSM)\nservice compatible with [VSCode](https://code.visualstudio.com/),\n[PyCharm](https://www.jetbrains.com/pycharm/),\n[Emacs](https://www.gnu.org/software/emacs/),\n[Sublime Text](https://www.sublimetext.com/),\n[mypy](https://github.com/python/mypy),\n[pyright](https://github.com/microsoft/pyright) and other tools.\n\nGenerated by\n[mypy-boto3-builder 8.1.2](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found on\n[types-aiobotocore](https://pypi.org/project/types-aiobotocore/) page and in\n[types-aiobotocore-ssm docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_ssm/).\n\nSee how it helps to find and fix potential bugs:\n\n![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)\n\n- [types-aiobotocore-ssm](#types-aiobotocore-ssm)\n  - [How to install](#how-to-install)\n    - [From PyPI with pip](#from-pypi-with-pip)\n  - [How to uninstall](#how-to-uninstall)\n  - [Usage](#usage)\n    - [VSCode](#vscode)\n    - [PyCharm](#pycharm)\n    - [Emacs](#emacs)\n    - [Sublime Text](#sublime-text)\n    - [Other IDEs](#other-ides)\n    - [mypy](#mypy)\n    - [pyright](#pyright)\n  - [Explicit type annotations](#explicit-type-annotations)\n    - [Client annotations](#client-annotations)\n    - [Paginators annotations](#paginators-annotations)\n    - [Waiters annotations](#waiters-annotations)\n    - [Literals](#literals)\n    - [Type definitions](#type-definitions)\n  - [How it works](#how-it-works)\n  - [What's new](#what's-new)\n    - [Implemented features](#implemented-features)\n    - [Latest changes](#latest-changes)\n  - [Versioning](#versioning)\n  - [Thank you](#thank-you)\n  - [Documentation](#documentation)\n  - [Support and contributing](#support-and-contributing)\n\n<a id=\"how-to-install\"></a>\n\n## How to install\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `types-aiobotocore` for `SSM` service.\n\n```bash\n# install with aiobotocore type annotations\npython -m pip install 'types-aiobotocore[ssm]'\n\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'types-aiobotocore-lite[ssm]'\n\n\n# standalone installation\npython -m pip install types-aiobotocore-ssm\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y types-aiobotocore-ssm\n```\n\n<a id=\"usage\"></a>\n\n## Usage\n\n<a id=\"vscode\"></a>\n\n### VSCode\n\n- Install\n  [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\n- Install\n  [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\n- Set `Pylance` as your Python Language Server\n- Install `types-aiobotocore[ssm]` in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[ssm]'\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `aiobotocore` code as usual.\n\n<a id=\"pycharm\"></a>\n\n### PyCharm\n\nInstall `types-aiobotocore-lite[ssm]` in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore-lite[ssm]'`\n```\n\nBoth type checking and code completion should now work. Explicit type\nannotations **are required**.\n\nUse `types-aiobotocore` package instead for implicit type discovery.\n\n<a id=\"emacs\"></a>\n\n### Emacs\n\n- Install `types-aiobotocore` with services you use in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[ssm]'\n```\n\n- Install [use-package](https://github.com/jwiegley/use-package),\n  [lsp](https://github.com/emacs-lsp/lsp-mode/),\n  [company](https://github.com/company-mode/company-mode) and\n  [flycheck](https://github.com/flycheck/flycheck) packages\n- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package\n\n```elisp\n(use-package lsp-pyright\n  :ensure t\n  :hook (python-mode . (lambda ()\n                          (require 'lsp-pyright)\n                          (lsp)))  ; or lsp-deferred\n  :init (when (executable-find \"python3\")\n          (setq lsp-pyright-python-executable-cmd \"python3\"))\n  )\n```\n\n- Make sure emacs uses the environment where you have installed\n  `types-aiobotocore`\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"sublime-text\"></a>\n\n### Sublime Text\n\n- Install `types-aiobotocore[ssm]` with services you use in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[ssm]'\n```\n\n- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"other-ides\"></a>\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything\nshould work.\n\n<a id=\"mypy\"></a>\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `types-aiobotocore[ssm]` in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[ssm]'\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"pyright\"></a>\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `types-aiobotocore[ssm]` in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[ssm]'\n```\n\nOptionally, you can install `types-aiobotocore` to `typings` directory.\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"explicit-type-annotations\"></a>\n\n## Explicit type annotations\n\n<a id=\"client-annotations\"></a>\n\n### Client annotations\n\n`SSMClient` provides annotations for `session.create_client(\"ssm\")`.\n\n```python\nfrom aiobotocore.session import get_session\n\nfrom types_aiobotocore_ssm import SSMClient\n\nsession = get_session()\nasync with session.create_client(\"ssm\") as client:\n    client: SSMClient\n    # now client usage is checked by mypy and IDE should provide code completion\n```\n\n<a id=\"paginators-annotations\"></a>\n\n### Paginators annotations\n\n`types_aiobotocore_ssm.paginator` module contains type annotations for all\npaginators.\n\n```python\nfrom aiobotocore.session import get_session\n\nfrom types_aiobotocore_ssm import SSMClient\nfrom types_aiobotocore_ssm.paginator import (\n    DescribeActivationsPaginator,\n    DescribeAssociationExecutionTargetsPaginator,\n    DescribeAssociationExecutionsPaginator,\n    DescribeAutomationExecutionsPaginator,\n    DescribeAutomationStepExecutionsPaginator,\n    DescribeAvailablePatchesPaginator,\n    DescribeEffectiveInstanceAssociationsPaginator,\n    DescribeEffectivePatchesForPatchBaselinePaginator,\n    DescribeInstanceAssociationsStatusPaginator,\n    DescribeInstanceInformationPaginator,\n    DescribeInstancePatchStatesPaginator,\n    DescribeInstancePatchStatesForPatchGroupPaginator,\n    DescribeInstancePatchesPaginator,\n    DescribeInstancePropertiesPaginator,\n    DescribeInventoryDeletionsPaginator,\n    DescribeMaintenanceWindowExecutionTaskInvocationsPaginator,\n    DescribeMaintenanceWindowExecutionTasksPaginator,\n    DescribeMaintenanceWindowExecutionsPaginator,\n    DescribeMaintenanceWindowSchedulePaginator,\n    DescribeMaintenanceWindowTargetsPaginator,\n    DescribeMaintenanceWindowTasksPaginator,\n    DescribeMaintenanceWindowsPaginator,\n    DescribeMaintenanceWindowsForTargetPaginator,\n    DescribeOpsItemsPaginator,\n    DescribeParametersPaginator,\n    DescribePatchBaselinesPaginator,\n    DescribePatchGroupsPaginator,\n    DescribePatchPropertiesPaginator,\n    DescribeSessionsPaginator,\n    GetInventoryPaginator,\n    GetInventorySchemaPaginator,\n    GetOpsSummaryPaginator,\n    GetParameterHistoryPaginator,\n    GetParametersByPathPaginator,\n    GetResourcePoliciesPaginator,\n    ListAssociationVersionsPaginator,\n    ListAssociationsPaginator,\n    ListCommandInvocationsPaginator,\n    ListCommandsPaginator,\n    ListComplianceItemsPaginator,\n    ListComplianceSummariesPaginator,\n    ListDocumentVersionsPaginator,\n    ListDocumentsPaginator,\n    ListOpsItemEventsPaginator,\n    ListOpsItemRelatedItemsPaginator,\n    ListOpsMetadataPaginator,\n    ListResourceComplianceSummariesPaginator,\n    ListResourceDataSyncPaginator,\n)\n\nsession = get_session()\nasync with session.create_client(\"ssm\") as client:\n    client: SSMClient\n\n    # Explicit type annotations are optional here\n    # Types should be correctly discovered by mypy and IDEs\n    describe_activations_paginator: DescribeActivationsPaginator = client.get_paginator(\n        \"describe_activations\"\n    )\n    describe_association_execution_targets_paginator: DescribeAssociationExecutionTargetsPaginator = client.get_paginator(\n        \"describe_association_execution_targets\"\n    )\n    describe_association_executions_paginator: DescribeAssociationExecutionsPaginator = (\n        client.get_paginator(\"describe_association_executions\")\n    )\n    describe_automation_executions_paginator: DescribeAutomationExecutionsPaginator = (\n        client.get_paginator(\"describe_automation_executions\")\n    )\n    describe_automation_step_executions_paginator: DescribeAutomationStepExecutionsPaginator = (\n        client.get_paginator(\"describe_automation_step_executions\")\n    )\n    describe_available_patches_paginator: DescribeAvailablePatchesPaginator = client.get_paginator(\n        \"describe_available_patches\"\n    )\n    describe_effective_instance_associations_paginator: DescribeEffectiveInstanceAssociationsPaginator = client.get_paginator(\n        \"describe_effective_instance_associations\"\n    )\n    describe_effective_patches_for_patch_baseline_paginator: DescribeEffectivePatchesForPatchBaselinePaginator = client.get_paginator(\n        \"describe_effective_patches_for_patch_baseline\"\n    )\n    describe_instance_associations_status_paginator: DescribeInstanceAssociationsStatusPaginator = (\n        client.get_paginator(\"describe_instance_associations_status\")\n    )\n    describe_instance_information_paginator: DescribeInstanceInformationPaginator = (\n        client.get_paginator(\"describe_instance_information\")\n    )\n    describe_instance_patch_states_paginator: DescribeInstancePatchStatesPaginator = (\n        client.get_paginator(\"describe_instance_patch_states\")\n    )\n    describe_instance_patch_states_for_patch_group_paginator: DescribeInstancePatchStatesForPatchGroupPaginator = client.get_paginator(\n        \"describe_instance_patch_states_for_patch_group\"\n    )\n    describe_instance_patches_paginator: DescribeInstancePatchesPaginator = client.get_paginator(\n        \"describe_instance_patches\"\n    )\n    describe_instance_properties_paginator: DescribeInstancePropertiesPaginator = (\n        client.get_paginator(\"describe_instance_properties\")\n    )\n    describe_inventory_deletions_paginator: DescribeInventoryDeletionsPaginator = (\n        client.get_paginator(\"describe_inventory_deletions\")\n    )\n    describe_maintenance_window_execution_task_invocations_paginator: DescribeMaintenanceWindowExecutionTaskInvocationsPaginator = client.get_paginator(\n        \"describe_maintenance_window_execution_task_invocations\"\n    )\n    describe_maintenance_window_execution_tasks_paginator: DescribeMaintenanceWindowExecutionTasksPaginator = client.get_paginator(\n        \"describe_maintenance_window_execution_tasks\"\n    )\n    describe_maintenance_window_executions_paginator: DescribeMaintenanceWindowExecutionsPaginator = client.get_paginator(\n        \"describe_maintenance_window_executions\"\n    )\n    describe_maintenance_window_schedule_paginator: DescribeMaintenanceWindowSchedulePaginator = (\n        client.get_paginator(\"describe_maintenance_window_schedule\")\n    )\n    describe_maintenance_window_targets_paginator: DescribeMaintenanceWindowTargetsPaginator = (\n        client.get_paginator(\"describe_maintenance_window_targets\")\n    )\n    describe_maintenance_window_tasks_paginator: DescribeMaintenanceWindowTasksPaginator = (\n        client.get_paginator(\"describe_maintenance_window_tasks\")\n    )\n    describe_maintenance_windows_paginator: DescribeMaintenanceWindowsPaginator = (\n        client.get_paginator(\"describe_maintenance_windows\")\n    )\n    describe_maintenance_windows_for_target_paginator: DescribeMaintenanceWindowsForTargetPaginator = client.get_paginator(\n        \"describe_maintenance_windows_for_target\"\n    )\n    describe_ops_items_paginator: DescribeOpsItemsPaginator = client.get_paginator(\n        \"describe_ops_items\"\n    )\n    describe_parameters_paginator: DescribeParametersPaginator = client.get_paginator(\n        \"describe_parameters\"\n    )\n    describe_patch_baselines_paginator: DescribePatchBaselinesPaginator = client.get_paginator(\n        \"describe_patch_baselines\"\n    )\n    describe_patch_groups_paginator: DescribePatchGroupsPaginator = client.get_paginator(\n        \"describe_patch_groups\"\n    )\n    describe_patch_properties_paginator: DescribePatchPropertiesPaginator = client.get_paginator(\n        \"describe_patch_properties\"\n    )\n    describe_sessions_paginator: DescribeSessionsPaginator = client.get_paginator(\n        \"describe_sessions\"\n    )\n    get_inventory_paginator: GetInventoryPaginator = client.get_paginator(\"get_inventory\")\n    get_inventory_schema_paginator: GetInventorySchemaPaginator = client.get_paginator(\n        \"get_inventory_schema\"\n    )\n    get_ops_summary_paginator: GetOpsSummaryPaginator = client.get_paginator(\"get_ops_summary\")\n    get_parameter_history_paginator: GetParameterHistoryPaginator = client.get_paginator(\n        \"get_parameter_history\"\n    )\n    get_parameters_by_path_paginator: GetParametersByPathPaginator = client.get_paginator(\n        \"get_parameters_by_path\"\n    )\n    get_resource_policies_paginator: GetResourcePoliciesPaginator = client.get_paginator(\n        \"get_resource_policies\"\n    )\n    list_association_versions_paginator: ListAssociationVersionsPaginator = client.get_paginator(\n        \"list_association_versions\"\n    )\n    list_associations_paginator: ListAssociationsPaginator = client.get_paginator(\n        \"list_associations\"\n    )\n    list_command_invocations_paginator: ListCommandInvocationsPaginator = client.get_paginator(\n        \"list_command_invocations\"\n    )\n    list_commands_paginator: ListCommandsPaginator = client.get_paginator(\"list_commands\")\n    list_compliance_items_paginator: ListComplianceItemsPaginator = client.get_paginator(\n        \"list_compliance_items\"\n    )\n    list_compliance_summaries_paginator: ListComplianceSummariesPaginator = client.get_paginator(\n        \"list_compliance_summaries\"\n    )\n    list_document_versions_paginator: ListDocumentVersionsPaginator = client.get_paginator(\n        \"list_document_versions\"\n    )\n    list_documents_paginator: ListDocumentsPaginator = client.get_paginator(\"list_documents\")\n    list_ops_item_events_paginator: ListOpsItemEventsPaginator = client.get_paginator(\n        \"list_ops_item_events\"\n    )\n    list_ops_item_related_items_paginator: ListOpsItemRelatedItemsPaginator = client.get_paginator(\n        \"list_ops_item_related_items\"\n    )\n    list_ops_metadata_paginator: ListOpsMetadataPaginator = client.get_paginator(\n        \"list_ops_metadata\"\n    )\n    list_resource_compliance_summaries_paginator: ListResourceComplianceSummariesPaginator = (\n        client.get_paginator(\"list_resource_compliance_summaries\")\n    )\n    list_resource_data_sync_paginator: ListResourceDataSyncPaginator = client.get_paginator(\n        \"list_resource_data_sync\"\n    )\n```\n\n<a id=\"waiters-annotations\"></a>\n\n### Waiters annotations\n\n`types_aiobotocore_ssm.waiter` module contains type annotations for all\nwaiters.\n\n```python\nfrom aiobotocore.session import get_session\n\nfrom types_aiobotocore_ssm.client import SSMClient\nfrom types_aiobotocore_ssm.waiter import CommandExecutedWaiter\n\nsession = get_session()\nasync with session.create_client(\"ssm\") as client:\n    client: SSMClient\n\n    # Explicit type annotations are optional here\n    # Types should be correctly discovered by mypy and IDEs\n    command_executed_waiter: CommandExecutedWaiter = client.get_waiter(\"command_executed\")\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`types_aiobotocore_ssm.literals` module contains literals extracted from shapes\nthat can be used in user code for type checking.\n\nFull list of `SSM` Literals can be found in\n[docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_ssm/literals/).\n\n```python\nfrom types_aiobotocore_ssm.literals import AssociationComplianceSeverityType\n\n\ndef check_value(value: AssociationComplianceSeverityType) -> bool: ...\n```\n\n<a id=\"type-definitions\"></a>\n\n### Type definitions\n\n`types_aiobotocore_ssm.type_defs` module contains structures and shapes\nassembled to typed dictionaries and unions for additional type checking.\n\nFull list of `SSM` TypeDefs can be found in\n[docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_ssm/type_defs/).\n\n```python\nfrom types_aiobotocore_ssm.type_defs import AccountSharingInfoTypeDef\n\n\ndef get_value() -> AccountSharingInfoTypeDef:\n    return {...}\n```\n\n<a id=\"how-it-works\"></a>\n\n## How it works\n\nFully automated\n[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully\ngenerates type annotations for each service, patiently waiting for\n`aiobotocore` updates. It delivers drop-in type annotations for you and makes\nsure that:\n\n- All available `aiobotocore` services are covered.\n- Each public class and method of every `aiobotocore` service gets valid type\n  annotations extracted from `botocore` schemas.\n- Type annotations include up-to-date documentation.\n- Link to documentation is provided for every method.\n- Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.\n\n<a id=\"what's-new\"></a>\n\n## What's new\n\n<a id=\"implemented-features\"></a>\n\n### Implemented features\n\n- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`\n  libraries\n- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`\n  compatibility\n- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type\n  annotations for each service\n- Generated `TypeDefs` for each service\n- Generated `Literals` for each service\n- Auto discovery of types for `boto3.client` and `boto3.resource` calls\n- Auto discovery of types for `session.client` and `session.resource` calls\n- Auto discovery of types for `client.get_waiter` and `client.get_paginator`\n  calls\n- Auto discovery of types for `ServiceResource` and `Resource` collections\n- Auto discovery of types for `aiobotocore.Session.create_client` calls\n\n<a id=\"latest-changes\"></a>\n\n### Latest changes\n\nBuilder changelog can be found in\n[Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n<a id=\"versioning\"></a>\n\n## Versioning\n\n`types-aiobotocore-ssm` version is the same as related `aiobotocore` version\nand follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n<a id=\"thank-you\"></a>\n\n## Thank you\n\n- [Allie Fitter](https://github.com/alliefitter) for\n  [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),\n  this package is based on top of his work\n- [black](https://github.com/psf/black) developers for an awesome formatting\n  tool\n- [Timothy Edmund Crosley](https://github.com/timothycrosley) for\n  [isort](https://github.com/PyCQA/isort) and how flexible it is\n- [mypy](https://github.com/python/mypy) developers for doing all dirty work\n  for us\n- [pyright](https://github.com/microsoft/pyright) team for the new era of typed\n  Python\n\n<a id=\"documentation\"></a>\n\n## Documentation\n\nAll services type annotations can be found in\n[aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_ssm/)\n\n<a id=\"support-and-contributing\"></a>\n\n## Support and contributing\n\nThis package is auto-generated. Please reports any bugs or request new features\nin [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)\nrepository.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Type annotations for aiobotocore.SSM 2.15.2 service generated with mypy-boto3-builder 8.1.2",
    "version": "2.15.2",
    "project_urls": {
        "Documentation": "https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_ssm/",
        "Homepage": "https://github.com/youtype/mypy_boto3_builder",
        "Source": "https://github.com/youtype/mypy_boto3_builder",
        "Tracker": "https://github.com/youtype/mypy_boto3_builder/issues"
    },
    "split_keywords": [
        "aiobotocore",
        "ssm",
        "type-annotations",
        "botocore",
        "mypy",
        "typeshed",
        "autocomplete"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fc2b373d2fcd955ca0cfa5dbe4f5a4818672d623a57bcbb2abcec92f9cb4bb65",
                "md5": "d780dcb296989602ff83f16a19c4f10e",
                "sha256": "a0ff9a6432b08b1cdd1889eda08f4a22822142a66141013c986bae876ebcb5aa"
            },
            "downloads": -1,
            "filename": "types_aiobotocore_ssm-2.15.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d780dcb296989602ff83f16a19c4f10e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 96513,
            "upload_time": "2024-10-10T01:39:42",
            "upload_time_iso_8601": "2024-10-10T01:39:42.775342Z",
            "url": "https://files.pythonhosted.org/packages/fc/2b/373d2fcd955ca0cfa5dbe4f5a4818672d623a57bcbb2abcec92f9cb4bb65/types_aiobotocore_ssm-2.15.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7062a149816fc226294cc6de00f4ff3d6ea536aefa4e726f1db0a80c06d227bc",
                "md5": "4605ba06ba3a9e32a2c7ef1c63276055",
                "sha256": "e9bf230635be761a1aa0cff1c74f2664087812774848284e40bfa6659a75e10e"
            },
            "downloads": -1,
            "filename": "types_aiobotocore_ssm-2.15.2.tar.gz",
            "has_sig": false,
            "md5_digest": "4605ba06ba3a9e32a2c7ef1c63276055",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 87808,
            "upload_time": "2024-10-10T01:39:43",
            "upload_time_iso_8601": "2024-10-10T01:39:43.831677Z",
            "url": "https://files.pythonhosted.org/packages/70/62/a149816fc226294cc6de00f4ff3d6ea536aefa4e726f1db0a80c06d227bc/types_aiobotocore_ssm-2.15.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-10 01:39:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "youtype",
    "github_project": "mypy_boto3_builder",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "types-aiobotocore-ssm"
}
Vlad Emelianov
Elapsed time: 0.42333s