# mypy-boto3-ssm
[![PyPI - mypy-boto3-ssm](https://img.shields.io/pypi/v/mypy-boto3-ssm.svg?color=blue)](https://pypi.org/project/mypy-boto3-ssm)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-ssm.svg?color=blue)](https://pypi.org/project/mypy-boto3-ssm)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
Type annotations for
[boto3.SSM 1.15.5](https://boto3.amazonaws.com/v1/documentation/api/1.15.5/reference/services/ssm.html#SSM) service
compatible with
[VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright)
and other tools.
Generated by [mypy-boto3-buider 3.1.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
- [mypy-boto3-ssm](#mypy-boto3-ssm)
- [How to install](#how-to-install)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [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)
- [Service Resource annotations](#service-resource-annotations)
- [Other resources annotations](#other-resources-annotations)
- [Collections annotations](#collections-annotations)
- [Typed dictionations](#typed-dictionations)
## How to install
Install `boto3-stubs` for `SSM` service.
```bash
python -m pip install boto3-stubs[ssm]
```
## Usage
### 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 `boto-stubs[ssm]` in your environment: `python -m pip install 'boto3-stubs[ssm]'`
Both type checking and auto-complete should work for `SSM` service.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[ssm]` in your environment: `python -m pip install 'boto3-stubs[ssm]'`
Both type checking and auto-complete should work for `SSM` service.
No explicit type annotations required, write your `boto3` code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed `boto3-stubs` submodules.
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[ssm]` in your environment: `python -m pip install 'boto3-stubs[ssm]'`
- Run `mypy` as usual
Type checking should work for `SSM` service.
No explicit type annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[ssm]` in your environment: `python -m pip install 'boto3-stubs[ssm]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `SSM` service.
No explicit type annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`SSMClient` provides annotations for `boto3.client("ssm")`.
```python
import boto3
from mypy_boto3_ssm import SSMClient
client: SSMClient = boto3.client("ssm")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: SSMClient = session.client("ssm")
```
### Paginators annotations
`mypy_boto3_ssm.paginator` module contains type annotations for all paginators.
```python
from mypy_boto3_ssm import SSMClient
from mypy_boto3_ssm.paginator import (
DescribeActivationsPaginator,
DescribeAssociationExecutionsPaginator,
DescribeAssociationExecutionTargetsPaginator,
DescribeAutomationExecutionsPaginator,
DescribeAutomationStepExecutionsPaginator,
DescribeAvailablePatchesPaginator,
DescribeEffectiveInstanceAssociationsPaginator,
DescribeEffectivePatchesForPatchBaselinePaginator,
DescribeInstanceAssociationsStatusPaginator,
DescribeInstanceInformationPaginator,
DescribeInstancePatchesPaginator,
DescribeInstancePatchStatesForPatchGroupPaginator,
DescribeInstancePatchStatesPaginator,
DescribeInventoryDeletionsPaginator,
DescribeMaintenanceWindowExecutionsPaginator,
DescribeMaintenanceWindowExecutionTaskInvocationsPaginator,
DescribeMaintenanceWindowExecutionTasksPaginator,
DescribeMaintenanceWindowSchedulePaginator,
DescribeMaintenanceWindowsForTargetPaginator,
DescribeMaintenanceWindowsPaginator,
DescribeMaintenanceWindowTargetsPaginator,
DescribeMaintenanceWindowTasksPaginator,
DescribeOpsItemsPaginator,
DescribeParametersPaginator,
DescribePatchBaselinesPaginator,
DescribePatchGroupsPaginator,
DescribePatchPropertiesPaginator,
DescribeSessionsPaginator,
GetInventoryPaginator,
GetInventorySchemaPaginator,
GetOpsSummaryPaginator,
GetParameterHistoryPaginator,
GetParametersByPathPaginator,
ListAssociationsPaginator,
ListAssociationVersionsPaginator,
ListCommandInvocationsPaginator,
ListCommandsPaginator,
ListComplianceItemsPaginator,
ListComplianceSummariesPaginator,
ListDocumentsPaginator,
ListDocumentVersionsPaginator,
ListResourceComplianceSummariesPaginator,
ListResourceDataSyncPaginator,
)
client: SSMClient = boto3.client("ssm")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
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_inventory_deletions_paginator: DescribeInventoryDeletionsPaginator = client.get_paginator("describe_inventory_deletions")
describe_maintenance_window_execution_task_invocations_paginator: DescribeMaintenanceWindowEx